CaBooky

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 📜 Kanban Board
  • 🎥 Rails Backend
  • 🎞️ CaBooky Preview
  • 🚀 Live Demo
• 💻 Getting Started with Create React App
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Usage
  • Run Tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 CaBooky

CaBooky is Car booking service. This application allows the users to subscribe(sign up) to the app so that the user can add new cars and be able to reserve the cars basing on the date and city. This app uses the external RESTful api endpoints for data accessing.

🛠 Built With

Tech Stack

Client

• React
• HTML
• CSS
• JavaScript

Key Features

• A user can add new items (cars)

• Current user can reserve the item basing the date and city.

• JavaScript and Stylelint linters are installed for code implementation improvement

• Uses React Redux middleware to work with async functions for API interactions"

• The application has CRUD operations.

(back to top)

Kanban Board

We are a Team of Four, so we used the custom Kanban board to divide tasks and keep track of progress.

• Kanban Board Initial version
• Kanban Board Final Version

(back to top)

Supporting Backend Project

• Vehicle-Booking-App-Backend

(back to top)

CaBooky Preview

(back to top)

🚀 Live Demo

• CaBooky Application

(back to top)

Getting Started with Create React App

This project was bootstrapped with Create React App.

More Information

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

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

• Node.js and npm

Setup

Clone this repository to your desired folder:

  cd my-folder

  git clone [email protected]:tan12082001/Vehicle-Booking-App-Frontend.git

  npm install

Usage

To run the project, if you are using a Code Editor make use of a live server. If you are working with webpack you can run the local host with the following command.

  npm start

Run Tests

To run the test suits:

  npm test

Deployment

You can deploy this project using:

  gh-pages

This Project is deployed using Render

(back to top)

👥 Authors

👤 Deborah Fashoro

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Nweneary Uzochukwu Winnie

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Suleiman Gacheru

• GitHub: @hetrox8
• Twitter: @suleimangacheru

👤 Tanmayi Manku

• GitHub: @tan12082001
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Apply admin authorization, and restrict the Create new car, delete a car actions unless admin.

• Add the Delete Reservation Feature.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the GitHub page.

(back to top)

⭐️ Show your support

If you like this project give it a star.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for providing the required lessons and tutorials for successfully completing the project.

We would like to thank Murat Korkmaz for the original Wireframe design of the application Vespa-Responsive-design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)