SLO Hacks Attendee Application Back End 2019

Welcome! This document will give you an overview of the technology behind this project and show you how you can contribute.

Tech Stack

The tools that we're using in this project.

Fork the repository and clone it to your machine.
Point your fork to the main repo by doing git remote add upstream https://github.com/slohacks/attendee-application-back-end
Install the global dependencies in this project: commitizen.
- e.g yarn global add commitizen
After installing the global dependencies, then you can install the project dependencies by running yarn or yarn install in the root of the folder.
Before beginning to develop, you will need to add a MongoDB URL to src/db/mongoose.js to allow Express to connect to your database.
Use the following commands as needed:
- To start up a development server: yarn run dev.
- To lint your code: yarn run lint.
Create a pull request on attendee-application-back-end against your fork
Address any changes requested by maintainers
- After merging your pull request, git pull upstream master on your master branch and create a new branch for a new feature.

To contribute to this project, you must conform to the following standards.

Required: Javascript Style Guide
- StandardJS
  - When you make a pull request, your code will be checked against StandardJS and will be marked green or red.
  - Pull requests that do not conform to StandardJS will not be accepted.

Required: use commitizen through git cz when commiting.
- Our repository is preconfigured to be commitizen-friendly
- Commits that do not conform to the conventional-changelog standard will not be accepted