Files
entgamers_pro/README.md
T
SrJuggernaut 3f1e80051f feat: static page
* feat: static site

* feat: mui support & basic theming

* feat: entgamers favicon

* feat: public images until dynamic content can be used

* feat: entgamers & gaming assets

* feat: eslint extra rules

* feat: mui theme modifications

* feat: fontawesome, gsap, bundle analyzer

* feat: common interfaces

* feat: basic layout

* chore: upadted dependencies

* chore: updated dependencies

* feat: updated link styles

* feat: layout now have better interfaces

* feat: basic seo component

* feat: static website

* feat: env variable rules in .gitignore

* feat: added lint to pre-commit

* docs: initial documentation

* ci: deploy using pm2

* ci: pm2 configuration file

* ci: github action deploy preview

* ci: github action deploy production

* ci: env variables now pass to pm2

* fix: pass environment to actions

* feat: post deploy as sudo

* fix: pass only required env to deploy

* revert: deploy as sudo

Refs: 624b225

* fix: server use isomorphic-fetch

* ci: use yarn instead npm

* fix: glass text contrast

* fix: production git ref

* docs: deploy env vars
2022-10-09 15:39:16 -05:00

2.3 KiB

EntGamers Website

Typescript  JavaScript Style Guide  JavaScript Style Guide  JavaScript Style Guide 

This is the source code for the EntGamers website.

Table of contents

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

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/.