Platform for book crossing between company employees Website
We are using simpliest github flow to organize our work:
We have master , develop and feature branches.
All features must be merged into develop branch!!!
Only the release should merge into the main branch!!!
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes using docker containers.
Docker version 17.05 or higher
Note: It's better to use docker-desktop if you are on windows
-
Clone repository from GitHub with $ git clone https://github.com/Lv-492-SoftServe/Bookcrossing-Back-End.git
-
Move to Bookcrossing-Back-End and execute "docker-compose up"
Note: Also check Bookcrossing-Back-End/src/BookCrossingBackEnd/examplesettings.json and save it as appsettings.json if you want to deploy without docker-compose or pass any extra variables!
You're encouraged to contribute to our project if you've found any issues or missing functionality that you would want to see. Here you can see the list of issues and here you can create a new issue.
Before sending any pull request, please discuss requirements/changes to be implemented using an existing issue or by creating a new one. All pull requests should be done into dev branch.
Though there are two GitHub projects: Bookcrossing-Back-End for back-end part and BookCrossing-Front-End for front-end part) all of the requirements are listed in the first one - Bookcrossing-Back-End.
Every pull request should be linked to an issue. So if you make changes on front-end part you should create an issue there (subtask) with a link to corresponding requirement (story, task or epic) on back-end.
All Pull Requests should start from prefix #xxx-yyy where xxx - task number and and yyy - short description
e.g. #020-CreateAdminPanel
Pull request should not contain any files that is not required by task.