Appoint Wheels ERD - Backend

📗 Table of Contents

• 📖 Frontend Link
• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 📖 API Documentation
• 💻 Getting Started
  • Install
  • Usage
  • Linters
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• 🙏 Acknowledgements
• 📝 License

📖 Frontend Link

• Frontend Link

📖 Rails AppointWheels

Appointment Wheels is a car rental application built with React and Ruby on Rails. The application allows users to book a car for a specific date and time. Users can create an account and log in to the application. The application is responsive and works on all devices.

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User Authentication with JWT
• User Authorization with CanCanCan
• User Roles
• Database Creation and Seeding
• API Documentation with Swagger

(back to top)

📖 API Documentation

• API Documentation in order to see the API documentation, you need to run the project locally and go to the link provided.

(back to top)

💻 Getting Started

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

Install

Install this project with:

  bundle install
  npm install

Usage

To run the project:

First you need to setup the JWT key the database

1. Delete credentials.yml.enc and master.key(if present)

2. Generate a secret JWT key with:

  bundle exec rake secret

If the above command doesn't work use this:

  rails secret

3. Save the generated secret key on a notepad

4. Generate new credentials and master key with:

  EDITOR='code --wait' rails credentials:edit

5. A new tab/window will open add the value 'devise_jwt_secret_key:' with secret key

6. Close the tab/window to save the configuration

You can setup the database with:

  rails db:setup

To run the server:

  rails server -p 3001

Linters

Use this command to fix Rubocop Linter Errors:

  rubocop -A

👥 Authors

👤 Author1

👤 Soban Syeed

• GitHub: SnakyMZ
• LinkedIn: Soban Syeed

👤 Karim Barragan

• GitHub: Rebelzob
• LinkedIn: Karim Barragan

👤 Ismael Mastronardi

• GitHub: IsmaelMastronardi
• LinkedIn: Ismael Mastronardi

👤 John Palacios

• GitHub: RysthCraft
• LinkedIn: John Palacios

(back to top)

🔭 Future Features

• Add a payment system
• Add a review system
• Search functionality

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

🙏 Acknowledgments

I would like to thank the following:

• Microverse for assigning us this project
• Our Stand Up Teams for their feedback and suggestions
• Team members for their collaboration to the project

Attribution:

• Murat Korkmaz for the design idea
• Creative Commons for the license

(back to top)

📝 License

This project is MIT licensed.

(back to top)