Skip to content

Commit 7778555

Browse files
authored
Merge pull request #180 from Ceridan/main
Update instructions for contributors
2 parents ef9bf4c + 96ab6b4 commit 7778555

2 files changed

Lines changed: 42 additions & 29 deletions

File tree

CONTRIBUTING.md

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,47 @@
2323

2424
### Backend
2525

26-
Install dependencies:
27-
```
28-
make install-backend-dependencies
29-
```
30-
Copy over path of env file:
31-
```
32-
cp ./packages/back-nest/.env.development ./packages/back-nest/.env
33-
```
34-
Start Docker Compose in the background:
35-
```
36-
make run-dev-db
37-
```
38-
Seed the db with example challenges
39-
```
40-
make run-seed-codesources
41-
```
42-
43-
Run the backend:
44-
```
45-
make run-backend-dev
46-
```
26+
1. Install dependencies:
27+
28+
```
29+
make install-backend-dependencies
30+
```
31+
1. Copy over path of env file:
32+
33+
```
34+
cp ./packages/back-nest/.env.development ./packages/back-nest/.env
35+
```
36+
37+
1. Generate [Github Access Token (classic)](https://github.com/settings/tokens) with `public_repo` permissions and update `GITHUB_ACCESS_TOKEN` variable in `./packages/back-nest/.env` with the token value. It is used to download seed data from GitHub.
38+
39+
1. Start Docker Compose in the background:
40+
41+
```
42+
make run-dev-db
43+
```
44+
45+
1. Seed the db with example challenges:
46+
47+
```
48+
make run-seed-codesources
49+
```
50+
51+
1. Run the backend:
52+
53+
```
54+
make run-backend-dev
55+
```
4756
4857
### Frontend
4958
50-
Install dependencies:
51-
```
52-
make install-webapp-dependencies
53-
```
54-
Run the frontend:
55-
```
56-
make run-webapp-dev
57-
```
59+
1. Install dependencies:
60+
61+
```
62+
make install-webapp-dependencies
63+
```
64+
65+
1. Run the frontend:
66+
67+
```
68+
make run-webapp-dev
69+
```

packages/back-nest/docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ services:
1212
environment:
1313
POSTGRES_USERNAME: postgres
1414
POSTGRES_PASSWORD: postgres
15+
POSTGRES_DB: speedtyper
1516

1617
adminer:
1718
image: adminer

0 commit comments

Comments
 (0)