https://github.com/neckerfree/carsapi

https://github.com/neckerfree/carsapi

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/neckerfree/carsapi
• Owner: NeckerFree
• Created: 2022-08-18T16:41:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-05T21:58:52.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T15:37:44.566Z (over 1 year ago)
• Language: Ruby
• Size: 121 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Microverse-blueviolet)

# 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](https://github.com/NeckerFree/CarsAPI/issues/23)

### Link to your Kanban board

[Actual Kanban board](https://github.com/NeckerFree/CarsAPI/projects/1)

### Live Demo (if available)

[Cars App](https://cars-capstone.herokuapp.com/)

## Front-end App - Cars ##

[Cars](https://github.com/NeckerFree/Cars/tree/dev)

## 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](https://github.com/NeckerFree)

- Twitter: [@ElioCortesM](https://twitter.com/ElioCortesM)

- LinkedIn: [elionelsoncortes](https://www.linkedin.com/in/elionelsoncortes/)

 


👤 **Oscar Bermudez**

- GitHub: [@githubhandle](https://github.com/zkr024)

- Twitter: [@twitterhandle](https://twitter.com/zkr024)

- LinkedIn: [LinkedIn](www.linkedin.com/in/oscar-bermudez-07908222a)

 


👤 **Amrendra K**

- GitHub: [@amrendrakind](https://github.com/amrendrakind)

- Twitter: [@amrendrak_](https://twitter.com/amrendrak_)

- LinkedIn: [amrendraakumar](https://linkedin.com/in/amrendraakumar)

 


## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is [MIT](./LICENSE) licensed.