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

https://github.com/rysth/react-appointwheels


https://github.com/rysth/react-appointwheels

Last synced: over 1 year ago
JSON representation

Awesome Lists containing this project

README

          



Logo

AppointWheels


# 📗 Table of Contents

- [💻 Backend Link repository](#backend-link)
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Install](#install)
- [Usage](#usage)
- [Linters](#linters)
- [👥 Authors](#authors)
- [📖 Kanban Board](#kanban-board)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 💻 Backend Link repository

- [**Backend Link**](https://github.com/Rysth/RAILS-AppointWheels)

# 📖 React AppointWheels

**AppointWheels** is a car rental application built with React and Ruby on Rails. The application allows users to book a car for a specific date and time. Users can create an account and log in to the application. The application is responsive and works on all devices.

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **Car Rental Booking:** Users can book a car for a specific date and time.
- **User Authentication:** Users can create an account and log in to the application.
- **Responsive Design:** The application is responsive and works on all devices.

(back to top)

## 💻 Getting Started

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

### Install

Clone the repository:

```bash
git clone https://github.com/Rysth/REACT-AppointWheels.git
cd REACT-AppointWheels
code . # To open VS Code Editor
```

### Usage

- Install the dependencies and start the server:

```bash
npm install
```

- Run the app in development mode:

```bash
npm start
```

### Linters

- CSS Checker:

```bash
npx stylelint "**/*.{css,scss}" --fix
```

- ESLint Checker:

```bash
npx eslint "**/*.{js,jsx}" --fix
```

## 🚀 Live Demo
- [Link to front end](https://appointwheels.onrender.com/)
- [Link to back end](https://rails-appointmentwheels.onrender.com/api-docs/index.html)

(back to top)

## 👥 Authors

👤 **Soban Syeed**

- GitHub: [SnakyMZ](https://github.com/SnakyMz)
- LinkedIn: [Soban Syeed](https://www.linkedin.com/in/soban-syeed/)

👤 **Karim Barragan**

- GitHub: [Rebelzob](https://github.com/Rebelzob)
- LinkedIn: [Karim Barragan](https://www.linkedin.com/in/karim-barragan/)

👤 **Ismael Mastronardi**

- GitHub: [IsmaelMastronardi](https://github.com/IsmaelMastronardi)
- LinkedIn: [Ismael Mastronardi](https://www.linkedin.com/in/ismael-mastronardi-361873271/)

👤 **John Palacios**

- GitHub: [RysthCraft](https://github.com/Rysth)
- LinkedIn: [John Palacios](https://www.linkedin.com/in/john-palacios-rysthcraft)

(back to top)

## 📖 Kanban-Board

- **Kanban Board Link:** [Kanban Board](https://github.com/users/Rysth/projects/2)
- **Kanban Board picture:** [Picture](./src/assets/images/kanban.png)
- **Number of Team Members:** 4

(back to top)

## 🔭 Future Features

- **Car Review:** Users can leave a review for a car.
- **Car Rating:** Users can rate a car.
- **Car Search:** Users can search for a car by name.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## 🙏 Acknowledgments

I would like to thank the following:

- [Microverse](https://www.microverse.org/) for assigning us this project
- Our Stand Up Teams for their feedback and suggestions
- Team members for their collaboration to the project

Attribution:

- [Murat Korkmaz](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign) for the design idea
- [Creative Commons](https://creativecommons.org/licenses/by-nc/4.0/) for the license

(back to top)

## 📝 License

This project is [MIT](./LICENSE.md) licensed.

(back to top)