Skip to content

Commit d99f90a

Browse files
committed
chore(docs): update setup docs
1 parent ffb388f commit d99f90a

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ http://localhost:4000/graphql
2020

2121

2222
## Local Setup (without Docker)
23+
You need to install PostgreSQL on your machine and run it:
24+
```bash
25+
e.g. on Mac OS:
26+
27+
brew install postgresql
28+
brew services start postgresql
29+
```
30+
31+
When the postgreSQL database it up and running then:
2332
1. Clone the repository and change into it
2433
```bash
2534
git clone [email protected]:SrMoffat/wer1-backend.git
@@ -31,26 +40,27 @@ cat .env.example >> .env
3140
```
3241
3. Create a [Music Story Account](https://developers.music-story.com/developers) and set the following environment variables in `.env`:
3342
```bash
34-
MUSIC_STORY_CONSUMER_KEY=
35-
MUSIC_STORY_CONSUMER_SECRET=
36-
MUSIC_STORY_ACCESS_TOKEN=
37-
MUSIC_STORY_ACCESS_TOKEN_SECRET=
38-
APP_SECRET_KEY=this can be any random string
43+
export MUSIC_STORY_CONSUMER_KEY=
44+
export MUSIC_STORY_CONSUMER_SECRET=
45+
export MUSIC_STORY_ACCESS_TOKEN=
46+
export MUSIC_STORY_ACCESS_TOKEN_SECRET=
47+
export APP_SECRET_KEY=this can be any random string
3948
```
40-
4. Add DB credentials to be used by docker for PostgreSQL
49+
4. Add DB credentials to be used for PostgreSQL
4150
```bash
42-
POSTGRES_USER="postgres"
43-
POSTGRES_PASSWORD="postgres"
44-
POSTGRES_DB="dev"
51+
export POSTGRES_USER="postgres"
52+
export POSTGRES_PASSWORD="postgres"
53+
export POSTGRES_DB="dev"
4554

4655
// Add server port
47-
PORT=4000
56+
export PORT=4000
4857
```
49-
5. Start server
58+
5. Export environment variables and then start the server
5059
```bash
5160
docker-compose up --build
5261
```
53-
6. Test the server
62+
63+
## Queries to test
5464
```bash
5565
Sign Up User
5666

0 commit comments

Comments
 (0)