NeckerFree / CarsAPI

Final capstone project: CarsAPI

This is a back-end application: A database that stores data to handle the car front-end app CRUD operations. The API was set to be accessed only when the user has been authenticated and each of the requests is made with JWT.

Built With

• Ruby on Rails
• PostgreSql
• FactoryBot - Faker
• Rspec

Initial state of Kanban board

Initial Kanban board

Link to your Kanban board

Actual Kanban board

Live Demo (if available)

Cars App

Front-end App - Cars

Cars

Getting Started

To get a local copy up and running follow these simple example steps.

• Clone Repository using git clone https://github.com/NeckerFree/CarsAPI.git
• Move into project directory cd CarsAPI

Setup Database

• Make sure that your Postgres database is installed.

• Open the file config\database.yml

• Modify the connection parameters to point your Postgres Database: username: [your_user] password: [your_password]

• If required drop existing database : rake db:drop

• Create databases: rake db:create

• Create db structure including tables : rake db:migrate

• If required seed initial data (stored in db\seeds.rb file): rails db:seed

Run Tests

• Install rspec: bundle install
• Run all tests: rspec
• Run all tests and show test documentation: rspec spec --format documentation

Run App

• If required (Not for testing) run rails server
• Visit http://localhost:3000/ in your browser!

Author

👤 Elio Cortés

• GitHub: @NeckerFree
• Twitter: @ElioCortesM
• LinkedIn: elionelsoncortes

 

👤 Oscar Bermudez

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

 

👤 Amrendra K

• GitHub: @amrendrakind
• Twitter: @amrendrak_
• LinkedIn: amrendraakumar

 

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.