Skip to content

PierreBougon/Bym-BackEnd

Repository files navigation

Bym API

Bym is an Epitech EIP project that aim to make the playlists sharable and collaborative

Project state

Master : Build Status - Develop : Build Status

Getting Started

Prerequisites

To start this server you need some dependencies use

govendor install +local

Installing

To try out Bym you should install Bym mobile application from the Play Store or AppStore.

Running the tests

Use go test to run the tests, please if you want to contribute be sure to write tests as well and make sure the are passing

Break down into end to end tests

Actually only the models are tested to guarantee a 100% sure solution when it comes to data

And coding style

Coding style is pretty free on this project I review every Pull Requests to be sure the code has enough quality to be merged, you should follow basic guidelines about clean code

Deployment

Every deployments are automatized with heroku, when a Pull Request is merge on Develop or Master and if the Travis CI assure 100% of tests passing


Contributing

Please feel free to open a Pull Request if you think you have a good piece of code that could be useful on production. You can also open issues to asks or discuss about anything in this project.

Authors

  • Pierre Bougon - Lead developer
  • Mathis Guilbon - Developer

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details

Acknowledgments

  • Bym Team to made this project a successful EIP