Skip to content

A Rest API that generates a wait-list (phone numbers or emails of potential clients) for products and services

Notifications You must be signed in to change notification settings

Usenmfon/wait-list-generator

Repository files navigation

Nest Logo

Wait List Generator

Wait List Generator is a NestJS application that allows a user to generate waitlists for a given event. This is useful for managing events where the number of participants is limited. With Wait List Generator, you can easily generate a waitlist for your event and keep track of participants who have registered for the event.

Table of Contents

Installation

To use Wait List Generator, you must first have Node.js and npm installed on your computer. If you do not have Node.js installed, you can download it from the official website: https://nodejs.org/en/.

After you have installed Node.js, you can clone this repository to your local machine using the following command:

git clone https://github.com/Usenmfon/wait-list-generator.git

Once you have cloned the repository, navigate to the project directory and install the required dependencies by running:

npm install

Usage

To use Wait List Generator, navigate to the project directory and start the application by running the following command:

npm run start

This will start the application and open a web browser to the default port of 8080. You can then access the application by navigating to http://localhost:8080.

To generate a waitlist for your event, enter the name of your event and the maximum number of participants for the event. You will then be prompted to enter the names and contact information of the participants who have registered for the event. Once you have entered all the participants, the application will generate a waitlist for the event.

The waitlist will be displayed in the web browser. You can also download the waitlist in CSV format by clicking the "Download Waitlist" button.

Contributing

If you would like to contribute to Wait List Generator, please follow these steps:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes and commit them to your branch
  4. Push your branch to your forked repository
  5. Open a pull request from your branch to the main repository

Before making a pull request, please ensure that your changes do not break the existing functionality and that all tests pass.

License

Wait List Generator is licensed under the MIT License. Feel free to use this application for personal or commercial purposes.

About

A Rest API that generates a wait-list (phone numbers or emails of potential clients) for products and services

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published