Car Book Backend

📗 Table of Contents

• 📗 Table of Contents
• Car book backend
  • Kanban Board
  • Initial state of the kanban board
  • Number of team members
  • Built With
    • Tech Stack
    • Key Features
  • API Documentation
    • Key Features
  • Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • Show your support
  • Acknowledgments
  • 📝 License

Car book backend

This is an API only setup using Ruby on rails as the back end. and have FC_FRONTEND as the front end.

Kanban Board

• Link to the kanban board

Initial state of the kanban board

Number of team members

• We are a team of 4 developers

Built With

• Ruby
• Ruby on Rails
• PostgresSQL

Tech Stack

Language

• Ruby

Framework

• Ruby on Rails

Database

• PostgresSQL

Key Features

Some useful features

• [API backend with Rails]

API Documentation

-Documentation

Key Features

Getting Started

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

Prerequisites

• Visual Studio Code must be installed on your computer | Download Visual Studio Code VSCode
• Git must be installed on your computer | Download Git

Setup

• Clone the repository
• Open the project folder in Visual Studio Code

Install

Install this project using:

• cd project/directory
• Git clone FC_BACKEND

Usage

To run the project, execute the following command:

• rails db:create
• rails db:migrate <!-- To migrate the database structure>
• rails db:seed <!-- To add initial data if they in exist in the seeds.rb file in the db folder>

Run tests

To run tests, run the following command:

• rspec ./spec/models/

Deployment

You can deploy this project using:

• Netlify
• Render

(back to top)

(back to top)

Authors

👤 Jean Emmanuel Cadet

• GitHub: @jecode93
• Twitter: @jecode93
• LinkedIn: jean-emmanuel-cadet

👤 Anshuman Singh Negi

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

👤 Okari Nyandika

• GitHub: 2004-Okari
• LinkedIn: Okari-Nyandika

👤 Noel FOKA

• GitHub: @noelfoka
• Twitter: noelnomgne
• LinkedIn: @noelfoka

🔭 Future Features

• [Desktop version]

(back to top)

🤝 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!

Acknowledgments

• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightful feedback.
• A great thanks to My coding partner(s), morning session team, and standup team for their contributions.

📝 License

This project is MIT licensed.