/socket-queue-app

Serve tickets (Queue app)

Primary LanguageJavaScriptMIT LicenseMIT

Socket Queue App

Table of Contents
  1. About The Project
  2. Development
  3. Base Dependencies
  4. Folder Structure
  5. License
  6. Credits

About the project

The app is all about practicing socket fundamentals and custom events.

For this, an application is created in which tickets can be created and attended to on the screen. We access the screens through a form and a name.
image


On this screen (or desktop) we can attend to these tickets one by one. In addition, we can see the pending tickets.
image

image

Technologies used

socket.io javascript nodejs

Development

Prerequisites

Before init, we need:

Make it your own

To get a local copy, clone it using:

git clone https://github.com/github_username/repo_name.git

Or get it downloading

rm -rf .git && git init
git add .
git commit -m "Initial commit"

Install dependencies:

pnpm install
#or
yarn install
#or
npm install 

Available Scripts

In this project, you can run the following scripts:

Scripts Description
pnpm dev Runs the app in the development mode.
pnpm start Runs the app in production mode.

Base Dependencies

  • cors for providing a Connect/Express middleware.
  • dotenv loads environment variables from a .env file into process.env.
  • socket.io bidirectional and low-latency communication for every platform.

Folder Structure

socket-queue-app/
├── db                       # Database
├── node_modules             # Third party libraries
├── public                    
|  ├── audio                  
|  ├── css                   # stylesheet 
|  ├── js                     
|  ├── index.html            # index file 
└── src                      # Root directory
|  ├── models                # Classes
|  ├── sockets               # Socket controllers
|  └── server                # Server configuration and initialization
├── .gitignore               # Files ignored at publish into github
├── app.js                   # Server instance
├── LICENSE                  # License information
├── nodemon.json             # nodemon configuration
├── package.json
├── pnpm-lock.yaml
└── README.md                 

License

This project is licensed under the terms of the MIT license.

Credits

Socket Queue App is built and maintained by Castro Maciel.

Badges used from Ileriayo • markdown-badges.