Web Api created to use in OneBitTwitter_Client
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.
You must have docker and docker-compose installed
For more information, please see https://docs.docker.com/install/
Access the project folder in your terminal enter the following
$ docker-compose build
$ docker-compose run --rm app bundle install
$ docker-compose run --rm app bundle exec rails db:create
$ docker-compose run --rm app bundle exec rails db:migrate
After that for test the installation enter the following to up the server
$ docker-compose up
To run the tests run the following in your terminal
$ docker-compose run --rm app bundle exec rspec
- Ruby on Rails - The web framework used
- PostgreSQL - SGDB
- Knock - Knock is an authentication solution for Rails API-only application based on JSON Web Tokens.
- CanCanCan - CanCanCan is an authorization library for Ruby >= 2.2.0 and Ruby on Rails >= 4.2 which restricts what resources a given user is allowed to access.
- Rack CORS Middleware - provides support for Cross-Origin Resource Sharing (CORS) for Rack compatible web applications.
- Rack::Attack - Rack middleware for blocking & throttling abusive requests.
- Sidekiq - FSimple, efficient background processing for Ruby.
- rspec-rails - brings the RSpec testing framework to Ruby on Rails as a drop-in alternative to its default testing framework, Minitest.
- factory_bot - factory_bot is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
- ffaker - is used to generated fake data.
- Ronaldo Carneiro da Silva Filho - Initial work - kikogamer
This project is licensed under the MIT License - see the LICENSE.md file for details
- The bootcamp super full stack team.