michael/merlyn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme with build instructions (#41)

Browse Source
This commit is contained in:
Tim Asp 2023-06-12 21:56:29 -07:00 committed by GitHub
parent 9092b0b55b
commit ebd3a62866
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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
### 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