Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/farida-hamid/melodyrentals-frontend

Melody Rentals is a musical instrument rental application. Built with: React, Bootstrap, CSS, and RSPEC.
https://github.com/farida-hamid/melodyrentals-frontend

bootstrap css3 react rspec

Last synced: 29 days ago
JSON representation

Melody Rentals is a musical instrument rental application. Built with: React, Bootstrap, CSS, and RSPEC.

Awesome Lists containing this project

README

        

logo

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [ Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Website Mockup 📱 💻 🖥️](#screenshots)
- [ Rails Backend](#rails-backend)
- [ Kanban Board](#kanban-board)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 Melody Rentals Frontend
![melodyrentals-logo](https://user-images.githubusercontent.com/101523582/216619313-5c1b5844-f5a3-4033-aa9a-819bf265590d.png)

**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

Server


  • Rails API

Database

### 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](https://github.com/Farida-Hamid/MelodyRentals-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 ](https://github.com/users/Farida-Hamid/projects/11)

(back to top)

## 🚀 Live Demo

- [Live Demo :rocket:] :smiley:

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

```sh
npm install # to install all the dependencies
```

### Usage

To run the project, execute the following command:

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

Run tests
```sh
npm test # for running the tests
```

(back to top)

## 👥 Authors (5 Micronauts)

👤 **Farida Hamid**

- LinkedIn: [LinkedIn](https://linkedin.com/in/farida-hamid)
- GitHub: [@Farida-Hamid](https://github.com/Farida-Hamid)

👤 **Megha Bodke**

- GitHub: [@megha-n-bodke](https://github.com/megha-n-bodke)
- LinkedIn: [Megha Bodke](https://www.linkedin.com/in/megha-bodke/)

👤 **Tracy Musongole**

- GitHub: [@TracyMuso](https://github.com/TracyMuso)
- LinkedIn: [Tracy Musongole](https://www.linkedin.com/in/tracy-muso/)

👤**Elie Harfouche**

- GitHub: [@X-Elie-X](https://github.com/X-Elie-X)
- LinkedIn: [Elie Harfouche](https://www.linkedin.com/in/elie-m-harfouche/)

👤 **Bantealem Geto**
- GitHub: [Bantealem](https://github.com/Bantealem)
- Twitter: [Bantealem](https://twitter.com/BantealemG)
- LinkedIn: [Bantealem](https://www.linkedin.com/in/bantealem-geto-a301b9213/)

(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](https://github.com/Farida-Hamid/MelodyRentals-FrontEnd).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

We would like to thank:
- [Microverse](https://www.microverse.org/)
- Code Reviewers

Under the the [Creative Commons liscense](https://creativecommons.org/licenses/by-nc/4.0/)

image

Original design from [Murat Korkmaz on Behance](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)

(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](./LICENSE) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)