vangelif / mvrva-transport-back-end

mvrva-transport

📗 Table of Contents

• 📗 Table of Contents
• 📖 mvrva-transport
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • API Documentation
    • Run tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • Kanban Board
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 mvrva-transport

This app is a desktop and mobile web application where a user can request for moving services by making a reservation for a particular service. The app has an admin section where the admin can add, edit and delete services. The app also has a user section where the user can view the services, make a reservation and delete that reservation.

🛠 Built With

Tech Stack

Client

• React

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Users can sign up and login.
• Services page after login.
• Details page for a particular service.
• A user can reserve a certain service
• Admin and user functionality for the app.

(back to top)

🚀 Live Demo

N/A

(back to top)

💻 Getting Started

Clone this repository to your desired folder:

git clone [e-mail]:Al-Amin-Khan-Shakil/mvrva-transport-back-end.git

(back to top)

Prerequisites

In order to run this project you need:

• Link to front end part of the site FrontEnd
• Ruby 3.1.2
• Browser (Google Chrome, Mozilla Firefox, Safari or any other browser)
• Run Rails Server

Setup

Clone this repository to your dist folder:

git clone [e-mail]:Al-Amin-Khan-Shakil/mvrva-transport-back-end.git
cd mvrva-transport-back-end

Install

Install this project with: bundle install

Delete the credentials.yml.enc and master.key(if present) file Create new master key and credential.yml.enc file by running the following command in the terminal: Git Bash command: EDITOR="code --wait", rails credentials:edit Save and close the credentials.yml.enc file and the master.key file will be created automatically.

Create Database: Git Bash Commands

• rails db:create
• rails db:migrate

Make sure that server is running = rails s

Usage

Use this project in the browsers of desktops and mobile devices

API Documentation

New User Registration user_registration POST https://mvrva-transport-11td.onrender.com/users/

New User Session GET https://mvrva-transport-11td.onrender.com/users/sign_in

Logout User DELETE https://mvrva-transport-11td.onrender.com/users/sign_out

API Services

• Get all service list GET https://mvrva-transport-11td.onrender.com/api/v1/services
• Create a new service POST https://mvrva-transport-11td.onrender.com/api/v1/services

API Individual Service

• Get specific service through id GET https://mvrva-transport-11td.onrender.com/api/v1/services/:id
• Delete specific service through id DELETE https://mvrva-transport-11td.onrender.com/api/v1/services/:id

API Reservations

• Get all reservation list GET https://mvrva-transport-11td.onrender.com/api/v1/reservations
• Create a new reservation POST https://mvrva-transport-11td.onrender.com/api/v1/reservations

API Individual Reservation

• Get specific reservation through id GET https://mvrva-transport-11td.onrender.com/api/v1/reservations/:id
• Delete specific reservation through id DELETE https://mvrva-transport-11td.onrender.com/api/v1/reservations/:id

👥 Authors

👤 Victor Kanyi

• GitHub: @jkanyi-web
• Twitter: @V_Kanyi
• LinkedIn: LinkedIn

👤 Vangelis Fotiades

• @github
• @twitter
• @linkedin

👤 Robert Kanyoro

• GitHub: @Kanyorok
• Twitter: @CarlosMbugua
• LinkedIn: Robert Mbugua

👤 Md Mahadi Hasan Rifat

• GitHub: (https://github.com/Rifat8080)
• Twitter: (https://twitter.com/mdmahadirifat98)
• LinkedIn: (https://www.linkedin.com/in/md-mahadi-hasan-rifat-8b7851265/)

👤 Al Amin Khan Shakil

• GitHub: Al Amin Khan Shakil
• Twitter: Al Amin Khan Shakil
• LinkedIn: Al Amin Khan Shakil

(back to top)

🔭 Future Features

• Add user notifications feature.
• Add user settings feature.
• Add user account deletion feature.
• Add user account activation feature.
• Add user account deactivation feature.
• Add user email verification feature.
• Add user profile picture upload feature.
• Add user profile picture delete feature.
• Add more styling to the app.
• Add payment feature.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Kanban Board

• Visit the kanban board
• link to initial kanban board:
• The final number of team members is 5

⭐️ Show your support

If you like this project, please let me know and we can improve it further. You are welcome to support this project by giving suggestions for improvement and leaving a star on the project.

🙏 Acknowledgments

We thank Murtk for the design of the frontend created for this project.
Acknowledgements and suggestions for improvement are always welcome

• https://stackoverflow.com/questions/53510040/carrierwave-argument-error-nil-location-provided-cant-build-uri-for-an-image

(back to top)

📝 License

This project is MIT licensed.

(back to top)