Good Builds

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Usage
4. Roadmap
5. Contact

About The Project

Built With

• PostgreSQL
• Express.js
• Pug.js
• JavaScript
• CSS
• Bcryptjs
• Express-session
• Express-validator
• Node.js

Installation

To run this application locally, you'll need to:

1. git clone this repo
2. cd into the local repo
3. npm install to install the dependencies
4. Create a .env file based on the .env.example file included in the repo with your own values
5. Create a user on your local machine with the username and password specified in your .env file in PostgreSQL
6. Run npx dotenv sequelize db:create to create the database
7. If the sequelize module is not found, try running npx dotenv sequelize-cli db:create and replace sequelize with sequelize-cli for the rest of these commands
8. Run npx dotenv sequelize db:migrate to run the migrations
9. Run npx dotenv sequelize db:seed:all to seed the database
10. Finally, start the development server with npm start. The scripts in the package.json should do the work. You'll see the local address you can use show up in the terminal.

Usage

Here we will list the features / user experience ---tbd

Roadmap

Checkout The Planning Docs At The Wiki Section

Contact

Amber Horn:

Andrew Cohen:

Michael Digiovanni:

Olga Thompson: