README.md

Bears-Team-5

Progress/Wellness PWA to track goals and create data visualizations for your progress.
Chingu | Voyage-5

Table of Contents

• About
• Live Demo
• Contributing
• Requirements
• Installation
• Build Tools
• Contributors
• License

About

App information coming soon!

Live Demo

Link to live demo coming soon!

Contributing

See link below for instructions on how to get your development environment setup and properly make a pull request.
Instructions

Requirements

• Node
• NPM

Installation

1. Clone or download this repo
2. Navigate to the root directory in your terminal
3. Run npm install to install all the dependencies
4. Run npm start to see live app
5. To make changes of your own, see contributing instructions

Command Scripts

npm {script}	Function/Description
start	Starts app on webpack dev server at localhost:3000
build	Creates production build for application in build directory
cypress	Runs cypress testing suite (specify tests)
cypress:all	Runs all cypress tests
server	Runs express server on localhost:3001
dev-server	Runs express server on localhost:3001 with nodemon

Routes

A recap of all the api routes

• POST /api/auth/login: Login route
• POST /api/auth/signin: Signin route
• POST /api/auth/logout: Logout route
• GET /api/goals/daily: Gets daily goals

Migrations

Run commands from the root folder

• sequelize db:migrate: Run migrations FROM the last migration made
• sequelize db:migrate:undo: Undo LAST migration
• sequelize db:migrate:undo:all: Undo ALL migrations
• sequelize db:seed:all: Seed all

More info on migrations here.

Build Tools

• Front-End
  • React v16
  • React Router
  • Redux
  • Styled Components
• Back-End
  • Express
  • Node
• Database
  • PostgreSQL
  • Sequelize
  • Passport (local & google oauth2) for authentication
• Testing/Tools
  • Cypress
  • CircleCI
  • ESLint (AirBnB)

Contributors

Madison Crocker
Mariano Heller
Dan Nguyen
Raymond Cox

License

License
This project was bootstrapped with Create React App