1️⃣ Backend deployed at heroku
To get the server running locally:
- Clone this repo
- npm i to install all required dependencies
- nodemon to start the local server
- npm test to start server using testing environment
- We chose this node stack due to a majority of the team being familiar with the technologies
- KNEX is an amazing query builder that allows you to write complex queries in javascript, a language the web team all knows and loves.
- We are using Postgres for easy persistent data. -Postgres makes working with relational databases remarkably easy.
Basic routes
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| POST | /api/auth/register |
All Users | Registers a new User to the database |
| POST | /api/auth/login |
All Users | Generates a token for a registered user |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /api/users/ |
all users | Returns all the users that exist |
| DELETE | /api/users/:id |
All Users | deletes a user from an organization. |
| PUT | /api/users/:id |
All Users | Updates info for a single user. |
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Frontend Documentation for details on the fronend of our project.