README for our Project

View Demo · Backend API · Documentation · Report Bug · Request Feature

Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
• Getting Started
  • Prerequisites
  • Run Locally
  • Deployment
• Usage
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

📷 Screenshots

👾 Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

🎯 Features

• Tours Creation
• Booking a tour
• Cancelaing reservations etc

🧰 Getting Started

‼️ Prerequisites

This project uses Npm as package manager

 npm install --global npm

🏃 Run Locally

Clone the project

  git clone https://github.com/ABDULALI3468/bookMe-frontend.git

Go to the project directory

  cd bookme-frontend

Install dependencies

  npm install

Start the server

  npm start

🚩 Deployment

To deploy this project run

  npm deploy

👀 Usage

How this App works is like when you run the app you will see the screen with all available tours. You can see their details but to reserve a Tour you need to Login ( if not Signup need to do it before ). Then you can reserve any number of available tours and cancel the reservation anytime. You can also start your own bussiness by creating a tour and incase you dont want it after creating you can delete it but all the reservation will also be destroyed!

👋 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⚠️ License

See LICENSE for more information.

🤝 Contact

Authors

FRONT END TEAM:

👤 **ABDUL ALI (TEAM LEADER) **

• This is My GitHub:
• This is My Linkedin:  
• This is My Twitter:  

👤 CHARLOTTE DIVINE

• This is My GitHub:
• This is My Linkedin:  
• This is My Twitter:  

BACK END TEAM:

👤 **Natnael Demelash (TEAM LEADER) **

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Taiwo Damola Adediran

• GitHub: @githubhandle
• LinkedIn: LinkedIn

💎 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Original design idea by Murat Korkmaz on Behance.
• Shields.io
• Awesome README
• Emoji Cheat Sheet
• Readme Template