Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 41 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,35 +23,47 @@

### Backend

Install dependencies:
```
make install-backend-dependencies
```
Copy over path of env file:
```
cp ./packages/back-nest/.env.development ./packages/back-nest/.env
```
Start Docker Compose in the background:
```
make run-dev-db
```
Seed the db with example challenges
```
make run-seed-codesources
```

Run the backend:
```
make run-backend-dev
```
1. Install dependencies:

```
make install-backend-dependencies
```
1. Copy over path of env file:

```
cp ./packages/back-nest/.env.development ./packages/back-nest/.env
```

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.

1. Start Docker Compose in the background:

```
make run-dev-db
```

1. Seed the db with example challenges:

```
make run-seed-codesources
```

1. Run the backend:

```
make run-backend-dev
```

### Frontend

Install dependencies:
```
make install-webapp-dependencies
```
Run the frontend:
```
make run-webapp-dev
```
1. Install dependencies:

```
make install-webapp-dependencies
```

1. Run the frontend:

```
make run-webapp-dev
```
1 change: 1 addition & 0 deletions packages/back-nest/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ services:
environment:
POSTGRES_USERNAME: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: speedtyper

adminer:
image: adminer
Expand Down