📗 Table of Contents

• 📖 About the Project
  • Built With
    • Tech Stack
    • Key Features
    • Website Mockup 📱 💻 🖥️
  • Rails Backend
  • Kanban Board
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Melody Rentals Frontend

Melody Rentals Frontend is a musicial instruments rental application where the user can register new accounts, login and reserve a set of different instruments. It is built and connected by using two different repos, including Back-end(Rails) and Front-end(React/Redux).

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails API

Database

• PostgreSQL

Key Features

• [Cars page display]
• [Reservation for luxary cars]
• [Login and Registration using API endpoint]

(back to top)

Website Mockup 📱 💻 🖥️

(back to top)

Rails Backend

• Here is the Backend part of the project Melody Rentals Backend

(back to top)

Kanban Board

• We are a group of 5 people, So we have devided each task for track of the project.

Kanban Board

• Kanban Board

(back to top)

🚀 Live Demo

• [Live Demo 🚀] 😃

(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 and Node.js installed on your computer.

• For windows users you can download Git from here: https://git-scm.com/download/win and Node.js from here: https://nodejs.org/en/download/
• For Mac users you can download Git from here: https://git-scm.com/download/mac and Node.js from here: https://nodejs.org/en/download/
• For Linux users you can download Git from here: https://git-scm.com/download/linux and Node.js from here: https://nodejs.org/en/download/

Install

Install this project with:

  npm install # to install all the dependencies

Usage

To run the project, execute the following command:

   npm start # for running the project in development mode
   npm run build # for building the project for production

Run tests

  npm test  # for running the tests

(back to top)

👥 Authors (5 Micronauts)

👤 Farida Hamid

• LinkedIn: LinkedIn
• GitHub: @Farida-Hamid

👤 Megha Bodke

• GitHub: @megha-n-bodke
• LinkedIn: Megha Bodke

👤 Tracy Musongole

• GitHub: @TracyMuso
• LinkedIn: Tracy Musongole

👤Elie Harfouche

• GitHub: @X-Elie-X
• LinkedIn: Elie Harfouche

👤 Bantealem Geto

• GitHub: Bantealem
• Twitter: Bantealem
• LinkedIn: Bantealem

(back to top)

🔭 Future Features

• [Make a 3D display of each car on Details Page that can be rotated]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

We would like to thank:

• Microverse
• Code Reviewers

Under the the Creative Commons liscense

Original design from Murat Korkmaz on Behance

(back to top)

❓ FAQ

• How I can install vite?

  • You can install vite by running npm install -g vite in your terminal.

• How I can run this project?

  • After cloning repository, run npm install to install all dependencies. Then run npm start to run the project.

• How I can run tests?

  • After cloning repository, run npm install to install all dependencies. Then run npm test to run the tests.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)