Skip to content
Snippets Groups Projects
Unverified Commit ebd3a628 authored by Tim Asp's avatar Tim Asp Committed by GitHub
Browse files

update readme with build instructions (#41)

parent 9092b0b5
No related branches found
No related tags found
No related merge requests found
...@@ -44,8 +44,9 @@ This monorepo consists of three main sections: ...@@ -44,8 +44,9 @@ This monorepo consists of three main sections:
### How to get started ### How to get started
- `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.
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.
...@@ -58,4 +59,4 @@ Next, you will need some content to embed. This could be a Youtube Channel, Medi ...@@ -58,4 +59,4 @@ Next, you will need some content to embed. This could be a Youtube Channel, Medi
### Contributing ### Contributing
- create issue - create issue
- create PR with branch name format of `<issue number>-<short name>` - create PR with branch name format of `<issue number>-<short name>`
- yee haw let's merge - yee haw let's merge
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment