README in progress!
TODO
Live2D Cubism Core SDK PixiJS https://github.com/pixijs/spine https://github.com/guansss/pixi-live2d-display https://github.com/davidfig/pixi-viewport
Make a local copy of the repo
git clone https://github.com/elysiumdelivery/altare-aquarium.git
Inside the created folder, run the following to install dev dependencies.
npm install
Make a local branch (you cannot push changes directly to main). <your-branch-name> can be any name you want.
git checkout -b <your-branch-name> origin/main
Because browsers are finnicky about accessing local files if there isn't a web server serving the page, live-server starts a development server and serves from there. Go to the folder you saved the git repo in and run
live-server
and the app should be served at http://localhost:8080, auto-reloading on each file save.
You can use the Github UI for simple text changes/ typo fixes:
https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files
To submit your changes for review, please select "Create a new branch... and start a pull request".
Push your local branch to Github to create a pull request
git push -u origin <your-branch-name>
Your terminal will then prompt you for your credentials. The password will be your personal access token. Here are steps on how to create one: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
A code review is not strictly required to merge, but it is encouraged to get feedback from at least one other person on the team before merging.