📗 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

📖 The Future Mobility Backend

The Future Mobility Backend is a Ruby on Rails API-only server to manage CRUD of vehicles and reservations in an electric cars website, which also allows the creation of new users and the login through an authentication mechanism. You can test it using the respective front-end webapp (https://future-mobility.netlify.app/). This full stack challenge was developed by a team of four members

Click here to see the FRONT-END project

🛠 Built With

Tech Stack

Client

• React JS

Server

• Ruby on Rails

Database

• PostgreSQL

Kanban Board

• kanban Board project
• Initial picture
• 4 Team Members Carlos Molina, @wandergithub, @Neeraj-Bhardwaj, @Agetuni

Key Features

• Create, Read and Delete operations of Vehicles
• Sign-up and Login of Users
• Create, Read and Delete operations of Reservations

(back to top)

🚀 Live Demo

• You can test this API-backend using the respective front-end webapp: https://future-mobility.netlify.app/

• Consult the documentation of the API-Backend in this link: https://documenter.getpostman.com/view/11181665/2s8ZDU74mn

  API Backend Service URL: https://future-mobility-backend.onrender.com/api/v1

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this Backend API Server you need:

• Ruby
• Rails
• Postgresql

Github

• Enter this url: https://github.com/Agetuni/the_future_mobility_backend in your web browser.
• Once opened navigate to the top left level of the project a green code download button will be visible on the righthand side.
• Select the download Zip option from drop-down menu.
• Once the download is complete you will be able to access my project locally.

Local (Terminal)

  git clone https://github.com/Agetuni/the_future_mobility_backend.git

Install

Install this project with the steps below:

• After cloning, type cd the_future_mobility_backend to access the project on the terminal.

• Run bundle install to install all the required dependancies.

• For developmente environment:

  • Create Database with rails db:create RAILS_ENV=development
  • Migrate Database with rails db:migrate RAILS_ENV=development
  • Populate data with rails db:seed RAILS_ENV=development

• For testing porpouses:

  • Create Database with rails db:create RAILS_ENV=test
  • Migrate Database with rails db:migrate RAILS_ENV=test

Usage

To run the project, execute the following command:

• Run rails s to start a development server (it will run in port 3001)
• Now, you are ready to consume the API endpoints

To run the tests of the project, execute the following command:

• Run rspec to start the tests
  
  

How to use this API

• Consult the documentation in this link: https://documenter.getpostman.com/view/11181665/2s8ZDU74mn

• You can use a local or remote Base URL

  • Local: http://localhost:3001

  • Remote (live demo): https://future-mobility-backend.onrender.com

(back to top)

👥 Authors

👤 Carlos Molina

• GitHub: Carlos Molina
• LinkedIn: Carlos Molina

👤 Wander Gonzalez

• GitHub: @wandergithub
• Twitter: @wanderklk1
• LinkedIn: Wander A. Gonzalez

👤 Aleazar Yilma

• GitHub: @Agetuni
• LinkedIn: LinkedIn
• AngelList: timo-wester

👤 Neeraj Bhardwaj

• GitHub: @Neeraj-Bhardwaj
• Twitter: @Neeraj-Bhardwaj
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add authorization feature to have an admin role
• Logic to not allow reservations of vehicles on dates already reserved
• Add logic to permit UPDATE of vehicles and reservations

(back to top)

🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue, feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project. Don't forget to give it a ⭐️

(back to top)

🙏 Acknowledgments

• This webpage is based on an original design provided by Murat Korkmaz on Behance. https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign

(back to top)

📝 License

This project is MIT licensed.

(back to top)