button-clicker is a template for creating incremental games.
Clone the repository:
git clone https://github.com/remarkablegames/button-clicker.git
cd button-clickerRename the project:
git grep -l button-clicker | xargs sed -i '' -e 's/button-clicker/my-clicker/g'
git grep -l 'Button Clicker' | xargs sed -i '' -e 's/Button Clicker/My Clicker/g'Update the files:
-
README.md -
index.html -
package.json -
public/manifest.json
Install the dependencies:
npm installInitialize a new repository:
rm -rf .git
git initMake your first commit:
git add .
git commit -m 'feat: initialize game from button-clicker'Commit messages follow the Conventional Commits format, which is used during release.
Once you're ready, push the local repository to GitHub (or another remote repository):
git remote add origin <remote-repository-url>
git push origin -u origin masterSet the environment variables:
less .envUpdate the Secrets in the repository Settings.
In the project directory, you can run:
Runs the game in the development mode.
Open http://localhost:5173 to view it in the browser.
The page will reload if you make edits.
You will also see any errors in the console.
Builds the game for production to the dist folder.
It correctly bundles in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your game is ready to be deployed!
Articles and diagrams that clarify idle game mechanics: