Skip to content

rapadds/EasyEatAPI

Repository files navigation

EasyEatAPI

This is the backend software whose purpose is handle the business model for EasyEat. It exposes the endpoints as a REST API that the different Clients can consume.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Will be filled while development begins

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Collaboration Rules

The collaboration Rules are simple and also very important. They ensure that everyone involved into this project know what and how to do the right things. Those rules help in preventing the chaos while testing the API. All collaborators have to follow those rules:

  • There is one branch for production: MASTER
  • There is one branch for development: DEVELOP
  • Each feature must be developped in a dedicated branch. Once the feature is done. The content of the branch will be merged to the DEVELOP's branch.
  • Once features in DEVELOP's branch are stables we merge to the MASTER's branch so that the feature can be pulled to production's environment.
  • Developper must annotate the commits with comprehensible comments.

Developpers

About

Backend of project that expose endpoint as a REST API. And assure the interaction with the database

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors