📗 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

📖 EL Dorado Frontend

El Dorado Frontend is a luxury car rental application where the user can register new accounts, login and reserve a set of different cars. 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 El Dorado Backend

(back to top)

Kanban Board

• We are a group of 4 people, so we used 2 Kanban Board to divide the work and keep track of the progress.

Frontend Kanban Board

• Frontend Kanban Board p-1
• Frontend Kanban Board p-2

Backend Kanban Board

• Backend Kanban Board p-1
• Backend Kanban Board p-2

(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 (4 Micronauts)

👤 Aamir Khan

• GitHub: @aamirkhan2478
• Twitter: @SmartKhan2478
• LinkedIn: Aamir Khan

👤 Abel Gebeyehu

• GitHub: @AbelG101
• LinkedIn: Abel Gebeyehu

👤 Michael Mesfin

• GitHub: @michael-duke
• Twitter: @MikeDuke21
• LinkedIn: MICHAEL MESFIN

👤 Milen Alebel

• GitHub: @milen-ale
• Twitter: @milenalebel2
• LinkedIn: Milen Alebel

(back to top)

🔭 Future Features

• [Admin Panel and access to add New lux Cars]
• [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.

(back to top)