monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2025-03-01 01:05:06 +08:00
Code Issues Projects Releases Packages Wiki Activity

rename manually to locally

Browse source
This commit is contained in:
Christian Fehmer 2024-07-23 18:45:06 +02:00 committed by GitHub
parent 228b8a2b0e
commit d9f1b1c729
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING_ADVANCED.md
View file

@ -12,7 +12,7 @@
- [Config file](#config-file)
- [Databases (optional if running frontend only)](#databases-optional-if-running-frontend-only)
- [Building and Running Monkeytype](#building-and-running-monkeytype)
- [Dependencies (if running manually)](#dependencies-if-running-manually)
- [Dependencies (if running locally)](#dependencies-if-running-locally)
- [Both Frontend and Backend](#both-frontend-and-backend)
- [Backend only](#backend-only)
- [Frontend only](#frontend-only)
@ -107,7 +107,7 @@ Follow these steps if you want to work on anything involving the database/accoun
2. Setup the database server
| Manual | Docker (recommended) |
| Locally | Docker (recommended) |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ol><li>Install [MongoDB Community Edition](https://docs.mongodb.com/manual/administration/install-community/)</li><li>Install [Redis](https://redis.io/docs/install/install-redis/)</li><li>Make sure both are running</li></ol> | <ol><li>Install [Docker](http://www.docker.io/gettingstarted/#h_installation) on your machine</li><li>Run `npm run docker-db-only` from the `./backend` directory</li></ol> |
@ -116,15 +116,15 @@ Follow these steps if you want to work on anything involving the database/accoun
## Building and Running Monkeytype
Its time to run Monkeytype. Just like with the databases, you can run the frontend and backend manually or with Docker.
Its time to run Monkeytype. Just like with the databases, you can run the frontend and backend locally or with Docker.
### Dependencies (if running manually)
### Dependencies (if running locally)
Run `npm i` in the project root to install all dependencies.
### Both Frontend and Backend
Manual:
Local:
```
npm run dev
@ -132,13 +132,13 @@ npm run dev
### Backend only
| Manual | Docker |
| Locally | Docker |
| --------------------------- | ------------------------------ |
| `npm run dev-be` | `cd backend && npm run docker` |
### Frontend only
| Manual | Docker |
| Locally | Docker |
| ---------------------------- | ------------------------------- |
| `npm run dev-fe` | `cd frontend && npm run docker` |