Trick or Treat

Website for a giveaway between sweets and challenges!

Content Table

• Description
• Screenshots
• Requirements
• Getting Started
• Environment Variables
• Conventional Commits
• License
• Contact

Description

Trick or Treat was a project made for the school's Halloween event where visitors opened the website and were drawn between sweets or challenges.

Screenshots

Requirements

1. NodeJS >= v16.x
2. npm >= v8.x

Getting Started

Follow the step-by-step instructions to set up and run the project:

1. Clone the repository:

   git clone https://github.com/Victor101106/Trick-or-Treat.git

2. Install dependencies:

   npm install

3. Configure environment variables:

   • Copy .env.example file and rename it to .env:

     cp .env.example .env

   • Update the .env file with the required values. Refer to the Environment Variables for details.

4. Run the project:

   npm run server

Environment Variables

To run the project correctly, you must set the required environment variables. Create a .env file in the root directory based on the .env.example file. Below is a description of the required variables:

Variable	Description	Example Value
PORT	The port where the server will listen	3030

Conventional Commits

This project follows the Conventional Commits specification to maintain a clean and consistent commit history.

Commitizen: How to Use

1. Stage your changes:

   git add [<pathspec>...]

2. Commit using Commitizen:

   npm run git:commit

3. Follow the interactive prompts. Commitizen will guide you through crafting a proper commit message.

Message Structure

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Example:

feat(auth): add login functionality

License

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

Contact

Victor Gabriel • Github • victorgabriel101106+github@gmail.com