Skip to content

Commit 455e4fe

Browse files
authored
Merge pull request #34 from codebytere/improve-readme
docs: add local setup to README
2 parents 22573d7 + 5ffeb2b commit 455e4fe

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
11
# QueerJS
22

3-
## Add a city
3+
## Getting Started
4+
5+
To run this site locally,
6+
7+
1. Run the following in terminal:
8+
9+
```sh
10+
npm i
11+
npm run dev
12+
```
13+
14+
or
15+
16+
```sh
17+
yarn install
18+
yarn run dev
19+
```
20+
21+
2. Navigate to `http://localhost:8000`.
22+
23+
## Adding a New Meetup City
424

525
- Go to data and make a new YAML file for your city
626
- Website to make google calendar links: https://decomaan.github.io/google-calendar-link-generator/
727

8-
If you have any issues please create an issue
28+
If you discover any bugs in this site, please [file an issue](https://github.com/queerjs/website/issues/new).
929

10-
Thank you
30+
Thank you

0 commit comments

Comments
 (0)