📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Website Mockup 📱 💻 🖥️
    • 🖺 Entity Relationship Diagram
  • Kanban Board
  • React Frontend
  • API Documentation
  • 🚀 Live Demo

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• ❓ FAQ

• 📝 License

📖 Regal Cars Backend

Regal Cars is car rental application where the user can create accounts, log in and reserve a set of different cars. It is built and connected by using two different repos: Back-end(Rails) and Front-end(React/Redux).

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails

Database

• PostgreSQL

Key Features

• [Car List endpoints]
• [Authentication to access Reservations]
• [Authenticated Users can add/remove a Car]
• [Authenticated Users can reserve a Car]

(back to top)

(back to top)

📇 Entity Relationship Diagram

React Frontend

• Here is the Backend part of the project Back end

🚀 kanban board

• Here is the kanban board of the project
• 

🚀 Live Demo

• Live Demo 🚀 😃 # COMING SOON!

(back to top)

💻 Getting Started

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

Prerequisites

To run this project you need: vscode and node

Install

 npx create-react-app

Usage || Clone

To run the project, execute the following command:

 git clone https://github.com/PromzzyKoncepts/Book-Appointment-Front-end.git

 npm install

   npm start ##  then go to localhost:8080

Run tests

npm test

# if you see any snapshots already created in __tests__ folder, 
#kindly DELETE the snapshot folder before running test, ELSE run npm test

(back to top)

👥 Authors (4 Micronauts)

👤 PROMISE OKECHUKWU

• GitHub: @promzzykoncepts
• Twitter: @pr0mzzy
• LinkedIn: promiseokechukwu

👤 Ndikumana Isaie

• GitHub: ndikumanaisaie
• Twitter: Ndikuma38670724
• LinkedIn: Ndikumana Isaie

👤 Abdullah Khan

• GitHub: @Abdullah
• Twitter: @Abdullah
• LinkedIn: @Abdullah

(back to top)

🔭 Future Features

• [Admin Roles and access to add New lux Cars]
• [Keep count of cars using addtional attribute]

(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

I would like to thank:

• Microverse
• Code Reviewers
• Many thanks to Murat Korkmaz for the wonderful design

(back to top)

❓ FAQ

• How I can install react

  • You can follow the official guide to install react. If you have node installed, you can run npx create-react-app to install react.

• How to run project?

  • After cloning the repository, run npm i and then run nmp start. This will run the server on localhost:8080. You can change the port number if you want.

• How I can run tests?

  • After cloning the repository, run npm test to run the tests.

(back to top)

📝 License

This project is MIT licensed.

(back to top)