Skip to content

Update README.md#37

Draft
adder206 wants to merge 2 commits intomainfrom
ReadMe
Draft

Update README.md#37
adder206 wants to merge 2 commits intomainfrom
ReadMe

Conversation

@adder206
Copy link
Collaborator

Created project ReadMe. Needs images

Created project ReadMe. Needs images
@adder206 adder206 added the documentation Improvements or additions to documentation label Jan 15, 2021
@adder206 adder206 added this to the MVP milestone Jan 15, 2021
@adder206 adder206 marked this pull request as draft January 15, 2021 17:14
Added suggested changes
@thirionlogan thirionlogan self-requested a review January 15, 2021 19:56
Comment on lines +46 to +55
## Set up

### `.env`

```
DB_NAME=
DB_PASS=
```

migrate the database with `npm run migrate`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be moved to "Setting Up in Development Mode"
Also INLINE_RUNTIME_CHUNK=false needs to be added to the sample .env

Comment on lines +23 to +45
### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add these sections for new scripts:

  • npm run server
  • npm run migrate
  • npm run seed
  • npm run rollback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants