docs: repo quickstart doc #262
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maxmousse
approved these changes
Sep 2, 2021
| # Quick Start | ||
| This article will help you quickly start the PWA and API to begin working on it. | ||
|
|
||
| - After cloning the source code on your computer, go to the repository root |
There was a problem hiding this comment.
I don't know if we want to add a note about the fact that some of the packages are private for the moment and that an npm authentication is required to use them.
| This article will help you quickly start the PWA and API to begin working on it. | ||
|
|
||
| - After cloning the source code on your computer, go to the repository root | ||
| - Install all dependencies by running `npm install` |
There was a problem hiding this comment.
Maybe add a note about the fact that the --force flag is often (always?) needed for the installation ?
| - Install all dependencies by running `npm install` | ||
| - Run `docker-compose up -d`. You may need to delete docker volumes for this command to work | ||
| - Sync your local database with its prisma schema, run `npm run prisma:db:push` and to populate the database run `npm run prisma:db:seed` | ||
| - Start the api by running `nx run api:serve` |
There was a problem hiding this comment.
Maybe add a note about the fact that nx must be installed globally to run this command ? Also, another way to run it without a globally installed nx is with npm run nx run api:serve =)
floross
force-pushed
the
main
branch
8 times, most recently
from
5edabd1
to
0c09e5f
Compare
floross
force-pushed
the
main
branch
2 times, most recently
from
bd36026
to
0a3283a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.