From d9f1b1c729eb0d2e637b1d47d0a2e87a948c242b Mon Sep 17 00:00:00 2001 From: Christian Fehmer Date: Tue, 23 Jul 2024 18:45:06 +0200 Subject: [PATCH] rename `manually` to `locally` --- CONTRIBUTING_ADVANCED.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING_ADVANCED.md b/CONTRIBUTING_ADVANCED.md index 39a7f7fb4..4e968c820 100644 --- a/CONTRIBUTING_ADVANCED.md +++ b/CONTRIBUTING_ADVANCED.md @@ -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) | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
  1. Install [MongoDB Community Edition](https://docs.mongodb.com/manual/administration/install-community/)
  2. Install [Redis](https://redis.io/docs/install/install-redis/)
  3. Make sure both are running
|
  1. Install [Docker](http://www.docker.io/gettingstarted/#h_installation) on your machine
  2. Run `npm run docker-db-only` from the `./backend` directory
| @@ -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` |