Skip to content

Commit c2ff899

Browse files
committed
update README
1 parent 40ec1bd commit c2ff899

1 file changed

Lines changed: 61 additions & 19 deletions

File tree

README.md

Lines changed: 61 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,77 @@
1-
# up.front.ug
1+
# up.front
22

3-
up.front is a monthly meetup
4-
for webdesigners & frontend developers in Berlin
3+
Website for [Up.front](https://upfrontug.github.io/) — a Berlin meetup for the web design and frontend community (2010–2019).
54

6-
* **Website**: https://upfrontug.github.io/
7-
* **Twitter**: https://twitter.com/upfront_ug
5+
Built with [Jekyll 4](https://jekyllrb.com/) and plain CSS. Deployed via GitHub Actions to GitHub Pages.
86

9-
---
7+
## Local development
108

11-
- Please push to gh-pages branch for website updates
12-
- If you would like to give a talk at one of our next meetups, please get in touch or fill out our call for proposals.
9+
Requirements: Ruby 3.3+ and Bundler.
1310

14-
---
11+
```bash
12+
bundle install
13+
bundle exec jekyll serve
14+
```
15+
16+
Open http://localhost:4000
17+
18+
To reach the site from another device on your network:
19+
20+
```bash
21+
bundle exec jekyll serve --host 0.0.0.0
22+
```
23+
24+
After changing `_config.yml`, restart the Jekyll server.
1525

16-
# Contributing
26+
## Deployment
1727

18-
If you would like to contribute to our site, please fork the project and then submit a pull request. We appreciate your help and will try to get back to you as soon as possible.
28+
Pushes to the `gh-pages` branch trigger the [GitHub Actions workflow](.github/workflows/pages.yml), which builds the site with Jekyll 4.4 and deploys to GitHub Pages.
1929

20-
# Run jekyll
30+
**One-time setup** (if not done yet): in the repository settings under **Pages**, set **Source** to **GitHub Actions** (not “Deploy from a branch”).
2131

22-
`$ bundle exec jekyll serve`
32+
## Project structure
2333

24-
If you want to open the site from an external device on your local network, run jekyll with:
34+
| Path | Purpose |
35+
|------|---------|
36+
| `_posts/` | Meetup posts (YAML front matter + optional HTML body) |
37+
| `_layouts/`, `_includes/` | HTML templates |
38+
| `css/` | Plain CSS stylesheets |
39+
| `images/` | Site and speaker images |
40+
| `*.html` | Static pages (about, archive, submit, …) |
2541

26-
`$ jekyll serve --host 0.0.0.0`
42+
Styles are plain CSS files linked from `_includes/head.html` — there is no Sass/SCSS build step.
43+
44+
## Adding a meetup post
45+
46+
Create a new file in `_posts/` named `YYYY-MM-DD-meetup.html`:
47+
48+
```yaml
49+
---
50+
counter: "87"
51+
intro: >
52+
Short intro shown on the event page.
53+
meetup: "https://www.meetup.com/up-front-ug/events/…"
54+
talks:
55+
- name: "Speaker Name"
56+
title: "Talk title"
57+
desc: "Talk abstract."
58+
bio: "Speaker bio."
59+
picture: "speaker-slug.jpg"
60+
links:
61+
- title: "@handle"
62+
url: "https://twitter.com/handle"
63+
---
64+
```
2765

66+
Speaker photos go in `images/talks/`. The default event time is `7:45pm` (set in `_config.yml`).
2867

29-
# Page build failure
68+
Browse existing posts in `_posts/` for examples.
3069

31-
If you receive a generic page build failure, try rebuilding by pushing an empty commit:
70+
## Contributing
3271

33-
`$ git commit -m 'rebuild pages' --allow-empty`
72+
1. Fork the repository
73+
2. Create a branch, make your changes
74+
3. Verify locally with `bundle exec jekyll build`
75+
4. Open a pull request against `gh-pages`
3476

35-
`$ git push`
77+
For content or design changes beyond bug fixes, please open an issue first so we can align on scope.

0 commit comments

Comments
 (0)