ticketfy-api

A Customer Support Ticket System API made with Rails - and ♥.

Dependencies

To run this project you need to have:

• Ruby 2.3.1 - You can use RVM
• MySQL

Setup the project

1. Install the dependencies above
2. $ git clone https://github.com/roalcantara/ticketfy-api.git - Clone the project
3. $ cd ticketfy-api - Go into the project folder
4. $ bin/setup - Run the setup script
5. $ bin/rspec - Run the specs to see if everything is working fine

If everything goes OK, you can now run the project!

Running the project

1. $ bundle exec rails s - Opens the server
2. Open http://localhost:3000

Running specs and checking coverage

$ bundle exec rake spec to run the specs.

$ coverage=on bundle exec rake spec to generate the coverage report then open the file coverage/index.html on your browser.

How to contribute

1. Follow the Semantic Versioning Specification
2. Follow the GitHub Flow
3. Follow the 5 Useful Tips For A Better Commit Message article and the How to Write a Git Commit Message post
4. Use Commitizen cli when committing

License

Ticketfy is released under the MIT License.