EntGamers Website

       

This is the source code for the EntGamers website.

Table of contents

• EntGamers Website
  • Development
    • Prerequisites
    • Setup
  • Contributing
  • Code of Conduct
  • Deployment

Development

This project uses Next.js and TypeScript. It is recommended to use Visual Studio Code as your editor. The project is configured to use ESLint for code formatting and linting, in standardJS style. It is also configured to use commitlint for commit message formatting.

Prerequisites

• Node.js
• Yarn

Setup

1. Clone the repository
2. Copy .env.example to .env.local and fill in the values
3. Run yarn install to install dependencies
   • This will also run husky install to install git hooks:
     • pre-commit will run yarn lint
     • commit messages will be linted using commitlint
4. Run yarn develop to start the development server
5. Open http://localhost:3000 in your browser

Contributing

Please read contributing for details on our contribution process.

Code of Conduct

Please read code of conduct for details on our code of conduct.

Deployment

The website is deployed using pm2. with github actions. The configuration is in .github/workflows/.