Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinayaktekade/appointment-booking
This is an web application made a part of a module to make appointment booking between people a lot easier. The usual process is to exchange mails between people till they find a convenient time. But this application can skip this process and book appointment by displaying available slots to users.
https://github.com/vinayaktekade/appointment-booking
appointment-booking
Last synced: 11 days ago
JSON representation
This is an web application made a part of a module to make appointment booking between people a lot easier. The usual process is to exchange mails between people till they find a convenient time. But this application can skip this process and book appointment by displaying available slots to users.
- Host: GitHub
- URL: https://github.com/vinayaktekade/appointment-booking
- Owner: VinayakTekade
- Created: 2020-12-30T06:09:28.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-15T08:06:24.000Z (over 3 years ago)
- Last Synced: 2023-03-05T14:56:35.202Z (over 1 year ago)
- Topics: appointment-booking
- Language: JavaScript
- Homepage: https://dr-john-appointment-booking.herokuapp.com/
- Size: 10.7 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dr John Appointment-Booking
Table of Contents
- About the Project
- Built with
- Getting started
- Prerequisites
- Project structure
- List of APIs
- Contribute
## About The Project
This is an web application made a part of a module to make appointment booking between people a lot easier. The usual process is to exchange mails between people till they find a convenient time. But this application can skip this process and book appointment by displaying available slots to users.
### Built With
This web application uses the following technology
- [ReactJS](https://reactjs.org)
- [Create React App](https://create-react-app.dev/)
- [Reactstrap](https://reactstrap.github.io/)
- [NodeJS](https://nodejs.org)
- [ExpressJS](https://expressjs.com/)
- [MomentJS](https://momentjs.com/)
- [Axios](https://www.npmjs.com/package/axios)
- [Firebase](https://firebase.google.com/)
- [Heroku](https://heroku.com)
## Getting Started
To preview this application online click here [https://dr-john-appointment-booking.herokuapp.com/](https://dr-john-appointment-booking.herokuapp.com/)
To run this application locally 2. Clone the repo
```sh
git clone https://github.com/VinayakTekade/Appointment-Booking
```
3. Install NPM packages in client directory and server directory
```sh
cd client
npm install
cd ../server
npm install
```
4. Create a firebase firestore database with collection name `event`
5. Add your firebase service account API key in `server/serviceAccountKey.json`
### Prerequisites
You need to have the following Prerequisite to get started
- NodeJS
- Firebase Account
## Project Structure
| Folder Path | Description |
| ------------------- | ------------------------------------------------------------------------------------- |
| client | This directory contains all the files needed for Client Side Rendering. |
| client/public | This directory contains all static content for the web app |
| client/src | This directory contains all the dynamic content for the web app |
| client/assets | This directory contains CSS and images required for each component of the web app |
| client/components | This directory contains all the components for each web page |
| client/timezones | This file contains all the strings of timezone as per the latest IANA database |
| server | This directory contains all the files needed for server side rendering |
| server/routes | This directory contains all the files to routes to API Calls |
| server/staticConfig | This file contains all the static configuration variables used throughout the backend |
## List of APIs
| API Routes | Parameters | Description |
| ------------ | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| /freeSlots | Date, Timezone | Return all the free slots available for a given date converted to whatever timezone we pass. |
| /createEvent | DateTime, Duration | All the data passed will create the event and store that into the firestore document, if the event already exists for that time you need to return status code 422 or else just store it and return with status 200. |
| /getEvents | startDate, endDate | Return all the events between given StartDate & EndDate |
## 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