https://github.com/csivitu/slot-booking-system
A slot booking system for scheduled events.
https://github.com/csivitu/slot-booking-system
appointment appointment-scheduling slot slot-bookin
Last synced: 8 months ago
JSON representation
A slot booking system for scheduled events.
- Host: GitHub
- URL: https://github.com/csivitu/slot-booking-system
- Owner: csivitu
- License: mit
- Created: 2020-12-05T14:22:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-12T06:44:57.000Z (about 5 years ago)
- Last Synced: 2025-08-02T00:56:12.721Z (11 months ago)
- Topics: appointment, appointment-scheduling, slot, slot-bookin
- Language: JavaScript
- Homepage:
- Size: 542 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![csivit][csivitu-shield]][csivitu-url]
[![Issues][issues-shield]][issues-url]
slot-booking-system
A system to manage slots for CCS and other CSI events.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contributors](#contributors-)
## About The Project
**slot-booking-system** is a smart solution to arrange discord meets for mass events like CCS. It automatically generate personalized discord invite links to achieve the same.
### Built With
* [Node](https://nodejs.org/en/)
* [Mongoose](https://www.npmjs.com/package/mongoose)
## Getting Started
To get a local copy up and running follow these simple steps.
### Installation
1. Clone the repo
```sh
git clone https://github.com/csivitu/slot-booking-system.git
```
2. Install NPM packages
```sh
npm install
```
#### Using yarn
```sh
yarn install
```
**Note:** If installing the packages with npm you get errors use yarn to install them.
## Usage
To run this project locally, you can run the following command.
#### Using npm
```sh
npm start
```
#### Using yarn
```sh
yarn start
```
## API Endpoints
|Request Type| Route | Function |
|:-----------:|:------:|:---------:|
| POST | / | Book a slot and generate an invite link |
| GET | / | Get invite link and slot details of a registered user |
| GET | /slots | Get slot details |
| POST | /reset | Initialize or reset the slots |
## Roadmap
See the [open issues](https://github.com/csivitu/slot-booking-system/issues) for a list of proposed features (and known issues).
## 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 'feat: Add some AmazingFeature'`)
4. Push to the Branch (`git push -u origin feature/AmazingFeature`)
5. Open a Pull Request
You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.
## License
Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
[csivitu-shield]: https://img.shields.io/badge/csivitu-csivitu-blue
[csivitu-url]: https://csivit.com
[issues-shield]: https://img.shields.io/github/issues/csivitu/slot-booking-system.svg?style=flat-square
[issues-url]: https://github.com/csivitu/slot-booking-system/issues