README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Rentomotors]

Rentomotors is an app that enables users to reserve cars for their personal benefits for a certain period of time.

Images

Links

• React Frontend of this app
• Api Documentation

🛠 Built With

• Ruby
• Rails
• Gem
• postgresql
• rswag

Tech Stack

This project was built using as major staks the following:

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

A user can login into the app after being authorized. A user can see add and delete cars. A user can reserve on or many of the cars in the app.

• [MVC]

(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:

Make sure you have installed locally: Ruby Nodejs

Setup

Clone this repository to your desired folder : git clone https://github.com/ogiogiovictor/Final-Group-Capstone-Reservation-Rails

Execute on console making sure you are in the correct directory:

bundle install
npm i

-create a file named application.yml under config folder and write the following Variables:

USER_NAME = “xxx” (xxx replace with your Postgres user name)
PASSWORD = “xxx” (xxx replace with your Postgres password)

-On console execute

rails db:create
rails db:migrate
rails db:seed

-Create Master key:

EDITOR="mate --wait" bin/rails credentials:edit

rails s

clone frontend app: git clone https://github.com/ogiogiovictor/Final-Group-Capstone-Reservation-React

Navigate to correct directory:

Add Dependencies

npm i

npm run dev

when asked for a new port for local host type "y"

(back to top)

API documentation

• Api Documentation

(back to top)

👥 Authors

Mention all of the collaborators of this project..

👤 Ogiogio Victor

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

👤 Omachi John

• GitHub: @Mromaci
• Twitter: @mr_omachi
• LinkedIn: John Omachi

👤 Silva Fernando César da

• GitHub: @fernando-silvabr66
• Twitter: @fsilvabr1
• LinkedIn: https://linkedin.com/in/fernando-silvabr66

(back to top)

🔭 Future Features

• [Authentication]
• [CRUD]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

leave a star if you enjoyed the project.

If you like this project star the project and leave a star

(back to top)

🙏 Acknowledgments

This project was built and developed around the UI idea of Murat Korkmaz on Creative Commons license of the design

We would like to thank Microverse.

(back to top)

📝 License

This project is MIT licensed.

(back to top)