Skip to content

Instantly share code, notes, and snippets.

@quetzaluz

quetzaluz/setup-readme.md

Last active August 26, 2020 22:15
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save quetzaluz/43e3215356aec10c8987457bddfc69d7 to your computer and use it in GitHub Desktop.
Save quetzaluz/43e3215356aec10c8987457bddfc69d7 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
setup-readme.md

The following is a sample of a readme Setup section for a node postgres stack:

Setup

  • Clone this repository to your local machine
  • Install the dependencies for the project
  • Ensure your PostgreSQL server is running
  • Create a User for this exercise
  • Create a database for the exercise with your user as the owner
  • Copy [do not rename] the example.env file as .env and update .env with the following fields with your database credentials:
 MIGRATION_DB_NAME=
 MIGRATION_DB_USER=
 MIGRATION_DB_PASS=
 DB_URL="postgresql://USERNAME@localhost/DATABASE_NAME"
  • Run the command npm run migrate -- 1 to create the database tables
  • You may now run the server locally with npm start
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment