📗 Table of Contents

• 📗 Table of Contents
• 👨‍💻 Fix Mate
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Database Setup
    • Running the App
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 License

👨‍💻 BookusNow

BookusNow is a backend system built using Node.js, Express, MongoDB, and Mongoose. It serves as the backbone for a booking application, providing essential functionalities such as user authentication, file uploading, location services, and weather updates.

API

• Base Url

• API Endpoints

• api/v1/events/
• api/v1/users/
• api/v1/users/admins

  • API Documentation

Link to Front End

• Live Link

• Link to Front-end Repository

Entity Relationship Diagram

🛠 Built With

Tech Stack

Key Features

The key features of this project include.

• Get all Events
• Get One Event
• User CreateEvent
• Delete Event by Admin
• Get all Users
• Get All Admins

💻 Getting Started

• Follow these steps to get a local copy up and running.

Prerequisites

Before you begin, make sure you have the following installed on your machine:

• Node.js: You can download Node.js here.
• npm (comes with Node.js): You can check if npm is installed by running the command npm -v in your terminal.
• MongoDB: You can install MongoDB here.
• A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode here, Sublime here, and Atom here.
• Git: You can download Git here.

• Version Requirements:

node >= 14.0.0
npm >= 6.14.0
mongodb >= 4.4

Setup

• To setup this project locally:

1. Open terminal in VScode.
2. Navigate to the directory where you want clone the copy of this repository.
3. Create new directory [optional].
4. Clone the repository by running the following command:

  git clone  [email protected]:AnsarIbrahim/bookusnow-backend.git

5. Navigate into the cloned repository:

cd bookusnow-backend

Installation

1. Install the required dependencies by running the following command:

npm install

Database Setup

• To start the MongoDB service, run the following command:

mongod

• To seed the database with sample data, you'll need to create a seed script. Once you have that, you can run it with the following command:

node seed.js

Please note that the command to start the MongoDB service might vary depending on your operating system and MongoDB installation. The seed script should be created in your project and should contain the logic to populate your database with sample data.

Running the App

• To run the application, run the following command:

npm start

• This will start the Rails development server and you can access the application by visiting http://localhost:5000 in your web browser.

👥 Authors

👤 Ansar Ibrahim

• GitHub
• LinkedIn
• Twitter

🔭 Future Features

• Add Booking
• Add Stripe

🤝 Contributing

• Contributions, issues, and feature requests are welcome!

• Feel free to check the issues page.

💖 Show your support

• Give a ⭐️, if you like this project!

🙏 Acknowledgments

• I would like to thank NovaNectar Services Pvt. Ltd.

📝 License

This project is MIT licensed.