Pithy project description
- Product Owner: Alice Lai
- Scrum Master: Olivia Sabo-Rush
- Development Team Members: Alice Lai, Devin Fields, Eric Periou, Olivia Sabo-Rush
To Use our app the User will need to first run npm install to get all of the dependencies.
A .env folder needs to be created in the root directory to harness all the environmental variables. Integral variables to get started are: PORT, MONGO_KEY:A Mongo Database Key, JWTSECRET:'this will be your secret salting phrase', a GOOGLE_MAP : api key is needed or the one provided is also available. Additional keys can be added for facebook, github and google logins, but for now the local login is the only available sign-in authentication system.
On initial loadup the user should be able to add users to their database, check for authentication with a Token based system from Passport login. Users will be able to geolocate a position and insert an event to the database with this positioning, which can be used when selecting an event to attend.
To run in development environment, run npm start and a webpack server will start up on the local host.
-MongoDB -Express -Mongoose -Node -React -Webpack
The prototype project is currently deployed in Heroku environment. You will need your own Heroku app to get started. Once in the new environment run npm install, and npm start. This will set up your build bundle and start the server for you. Refer to Heroku CLI commands https://devcenter.heroku.com/articles/heroku-cli for information on incorporating your own environmental variables for the MongoKey, port and JWT secrets. After this point you can set up an upstream remote to push future changes or automate the updates using Github's on pull request merge criterion.
From within the root directory:
npm install -S
See CONTRIBUTING.md for contribution guidelines.