Project Name Pithy project description
Team Product Owner: J.P. Da Prato Scrum Master: Duke Goulden Development Team Members: Carlos Astrada, Michael Banzon, Fredrick Lou
Table of Contents Usage Requirements Development Installing Dependencies Tasks Team Contributing
Usage 1.Start MYSQL/MariaDB a. In terminal run: 'mysql.server start' b. Then in terminal run: 'mysql -u root -p' c. press enter when password is requested 2.In SQL, create database "barback" 3.Create .env file in root directory with the following:
HOST=localhost PORT=7337
3.NPM Install
- NPM Install will first install dependencies then,
- Postinstall will auto-run
-Postinstall will perform the following actions
- Parcel Build - (webpack alternative to build react dist)
- NPM run copy:media - Copies image files into dist folder
- NPM run db:setup - Seeds the database with initial data
- Connect to the front end through http://localhost/1234 (parcel defaults to port 1234)
Requirements Node >= V8 MYSQL or MariaDb
Development Installing Dependencies From within the root directory:
npm install Roadmap View the project roadmap here
Make sure you check out the wiki for things of note
Contributing See CONTRIBUTING.md for contribution guidelines.