Skip to content
Snippets Groups Projects
Commit 8af817e2 authored by timothycarambat's avatar timothycarambat
Browse files

update local dev docs

parent 2036204f
No related branches found
No related tags found
No related merge requests found
...@@ -71,7 +71,15 @@ This monorepo consists of three main sections: ...@@ -71,7 +71,15 @@ This monorepo consists of three main sections:
- `yarn setup` from the project root directory. - `yarn setup` from the project root directory.
- This will fill in the required `.env` files you'll need in each of the application sections. Go fill those out before proceeding or else things won't work right. - This will fill in the required `.env` files you'll need in each of the application sections. Go fill those out before proceeding or else things won't work right.
- `cd frontend && yarn install && cd ../server && yarn install` from the project root directory. - `cd frontend && yarn install && cd ../server && yarn install` from the project root directory.
To boot the server locally (run commands from root of repo):
- ensure `server/.env.development` is set and filled out.
`yarn dev:server`
To boot the frontend locally (run commands from root of repo):
- ensure `frontend/.env` is set and filled out.
- ensure `VITE_API_BASE="http://localhost:3001/api"`
`yarn dev:frontend`
Next, you will need some content to embed. This could be a Youtube Channel, Medium articles, local text files, word documents, and the list goes on. This is where you will use the `collector/` part of the repo. Next, you will need some content to embed. This could be a Youtube Channel, Medium articles, local text files, word documents, and the list goes on. This is where you will use the `collector/` part of the repo.
......
VITE_API_BASE='http://localhost:3001/api' # Use this URL when developing locally
# VITE_API_BASE='/api' # Use this URL deploying on non-localhost address OR in docker.
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
"scripts": { "scripts": {
"lint": "cd server && yarn lint && cd .. && cd frontend && yarn lint", "lint": "cd server && yarn lint && cd .. && cd frontend && yarn lint",
"setup": "cd server && yarn && cd ../frontend && yarn && cd .. && yarn setup:envs && echo \"Please run yarn dev:server and yarn dev:frontend in separate terminal tabs.\"", "setup": "cd server && yarn && cd ../frontend && yarn && cd .. && yarn setup:envs && echo \"Please run yarn dev:server and yarn dev:frontend in separate terminal tabs.\"",
"setup:envs": "cp -n ./server/.env.example ./server/.env.development && cp -n ./collector/.env.example ./collector/.env && cp -n ./docker/.env.example ./docker/.env && echo \"All ENV files copied!\n\"", "setup:envs": "cp -n ./frontend/.env.example ./frontend/.env && cp -n ./server/.env.example ./server/.env.development && cp -n ./collector/.env.example ./collector/.env && cp -n ./docker/.env.example ./docker/.env && echo \"All ENV files copied!\n\"",
"dev:server": "cd server && yarn dev", "dev:server": "cd server && yarn dev",
"dev:frontend": "cd frontend && yarn start", "dev:frontend": "cd frontend && yarn start",
"prod:server": "cd server && yarn start", "prod:server": "cd server && yarn start",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment