Giter Club home page Giter Club logo

vehicles's Introduction

README

Simple API written in Rails 6 to handle vehicles, models and brands. Ruby Version 2.7.0

Getting Started

Setup the project

git clone https://github.com/danilolic/vehicles.git
cd vehicles
bundle install
touch config/master.key && echo -e "395a8e6203ebea08e42b35be14434763" >> config/master.key
touch config/credentials/development.key && echo -e "ad5f9b1bc62da63566bc74e5736e6704" >> config/credentials/development.key
touch config/credentials/test.key && echo -e "ccc185978088b9b086dabbb4602b0247" >> config/credentials/test.key
rails db:create db:migrate db:seed

Warning: Do not share your master key if you have sensitive data.

With db:seed you can get some samples to query.

Initialize

rails s

You can see the API docs here:

https://documenter.getpostman.com/view/6655494/T1LLDTCb

You can try on Heroku

https://polar-brushlands-02894.herokuapp.com/api/brands

Authentication:

The api uses JWT with refresh tokens as strategy to authentication if you are not familiar see that:

https://auth0.com/blog/refresh-tokens-what-are-they-and-when-to-use-them/

Nested Routes (I know this is outside the initial specification)

The api uses nested routes to improve readability.

Coverage

You can see the test coverage opening on the browser the file coverage/index.html

Code Quality

You can see the code quality running on the root folder:

rubycritic app/

Security Issues:

You can see for security issue running on the root folder:

brakeman

vehicles's People

Contributors

danilolic avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.