Skip to content

Latest commit

 

History

History
191 lines (132 loc) · 4.88 KB

README.md

File metadata and controls

191 lines (132 loc) · 4.88 KB
Raw

Logo

Book Your Appointment

A booking system for Doctors, Clinics and Laboratories.
View Demo

· Report Bug · Request Feature

Table of Contents

About The Project

Index Dashboard

This is a MERN stack booking system built for learning, understanding and enhancing my skills.

Key Features:

  • Real Time Updates
  • Unit Testing
  • CI/CD integration
  • Optimized for production built

Built With

This project was made possible due to

  • React
  • MongoDB
  • Express
  • NodeJS
  • Firebase Authentication
  • Pusher
  • Formik
  • Bulma

Getting Started

Prerequisites

Tools needed to run this project

  • npm
  • yarn
  • nodejs

Installation

  1. You need to have API Keys for MongoDB Atlas, Firebase and Pusher
  2. Clone the repo
git clone https://github.com/SkSumit/BookMyAppointment.git
  1. Install packages

Backend

cd .\backend\
npm install

Frontend

cd .\frontend\
yarn install
  1. Create two .env files, one in Backend and other in Frontend folder. Add your mongodb atlas and pusher key in the backend .env file , add firebase and again add pusher keys in the frontend .env file
const API_KEY = 'ENTER YOUR API';

Running

Backend would be running on PORT 3000

npm run backend

Open new terminal to run front-end

Frontend would be running on PORT 3001

npm run frontend

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sumit Kolpekwar - [email protected]

Acknowledgements