📗 Table of Contents

📗 Table of Contents

• 📖 Vesper-backend
• 🛠 Built With
• 💻 Getting Started
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• 📝 License

📖 Vesper-backend

Vesper-backend is the rails backend API application for the full stack vesper app. It provides all the endpoints for the frontend to consume. Here the logic for the app is implemented.

🛠 Built With

Tech Stack

Server

• Ruby
• Rails

Database

• PostgreSQL

Key Features

• Handles logic for storing and retrieving data from the database
• Handle logic for authentication and authorization
• Handles logic for returning data to the frontend

(back to top)

🩺 Documentation

• Api docs

(back to top)

🎨 Link to Frontend

• Frontend

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 git
 bundle
 Your favorite text editor

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Shisui6/car-rental-back-end.git

Database setup

Connect to your local postgres database:

  add a .env file to the root directory
  inside the .env file, set the following environment variables:

  POSTGRES_USER=<username>
  POSTGRES_PASSWORD=<password>
  POSTGRES_HOST=<host>
  POSTGRES_PORT=<port>

  Make sure to replace the default text after the '=' sign with values for your local environment

Install

Install this project with:

  cd car-rental-back-end
  bundle install
  rails: db:create - create the database
  rails: db:migrate - run pending migrations for the current environment.

Usage

To run the project, execute the following command:

  rails server - Starts the development server
  rails console - Starts the interactive command line

Run tests

To run tests, run the following command:

  rspec - Runs the test suite

(back to top)

👥 Authors

👤 Shisui

• GitHub: @Shisui6
• LinkedIn: LinkedIn

👤 Sonick

• GitHub: @Sonickmumba
• LinkedIn: LinkedIn

👤 Usirusen

• GitHub: @UsirusenIkon
• LinkedIn: LinkedIn

👤 Yousufi

• GitHub: @zakiyousufi
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add more endpoints

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please leave a star🤩

(back to top)

🙏 Acknowledgments

• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)