https://github.com/victor101106/trick-or-treat
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.
https://github.com/victor101106/trick-or-treat
2d 2d-game canvas game halloween halloween-game html5-canvas javascript pixel-art pixel-art-game pixelart pixelart-game treat trick
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/victor101106/trick-or-treat
- Owner: Victor101106
- License: mit
- Created: 2022-10-17T14:45:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-22T18:34:49.000Z (4 months ago)
- Last Synced: 2025-02-22T19:30:00.125Z (4 months ago)
- Topics: 2d, 2d-game, canvas, game, halloween, halloween-game, html5-canvas, javascript, pixel-art, pixel-art-game, pixelart, pixelart-game, treat, trick
- Language: JavaScript
- Homepage:
- Size: 269 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Trick or Treat
Website for a giveaway between sweets and challenges!
## Content Table
- [Description](#description)
- [Screenshots](#screenshots)
- [Requirements](#requirements)
- [Getting Started](#getting-started)
- [Environment Variables](#environment-variables)
- [Conventional Commits](#conventional-commits)
- [License](#license)
- [Contact](#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:
```bash
git clone https://github.com/Victor101106/Trick-or-Treat.git
```
2. Install dependencies:
```bash
npm install
```
3. Configure environment variables:
- Copy `.env.example` file and rename it to `.env`:
```bash
cp .env.example .env
```
- Update the `.env` file with the required values. Refer to the [Environment Variables](#environment-variables) for details.
4. Run the project:
```bash
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](https://www.conventionalcommits.org/) specification to maintain a clean and consistent commit history.
### Commitizen: How to Use
1. Stage your changes:
```bash
git add [...]
```
2. Commit using `Commitizen`:
```bash
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:
```bash
[optional scope]:
[optional body]
[optional footer(s)]
```
#### Example:
```bash
feat(auth): add login functionality
```
## License
Distributed under the MIT license. See [LICENSE](LICENSE.md) for more information.
## Contact
Victor Gabriel • [Github](https://github.com/Victor101106/) • [email protected]