Before running any of these commands below, make sure to have installed:
NodeJS >= 24.0.0 - https://nodejs.org/en/ git - https://git-scm.com/downloads
VSCode - https://code.visualstudio.com/Download
- Fork this repository at https://github.com/Pseudo-Corp/SynergismOfficial/fork
- Clone the repository you forked with
git clone https://github.com/<USERNAME>/SynergismOfficial(make sure to change<USERNAME>with your own GitHub username). - cd SynergismOfficial
- Install the project dependencies, running
npm install(ormake install- If you intend to usemakefrom here and on, make sure it is installed first) - Switch to a new branch with
git checkout -b "my-branch-name" - Run
node --run dev(ormake dev) - Make your desired changes and test them.
- Typecheck all your TypeScript files by running
node --run check:tsc(ormake check). - Lint the code by running
node --run lint(ormake lintcode). - Lint the CSS by running
node --run csslint(ormake lintcss). - Run
git add /path/to/filefor every file updated or created (orgit add -Afor every file). - If everything is good to go, commit your changes with
git commit -m "title of my commit" - Push your changes to your personal Github Repository with
git push -u origin my-branch-name - Open a Pull Request (PR) on the Official Synergism Repository at https://github.com/Pseudo-Corp/SynergismOfficial/pulls (make sure you click on
compare across forksto select your fork and branch)
To get a list of available commands in the Makefile, run make help or just make