https://github.com/pokeclicker/pokeclicker
The new and improved version of the popular idle/incremental PokéClicker
https://github.com/pokeclicker/pokeclicker
game hacktoberfest javascript
Last synced: 3 months ago
JSON representation
The new and improved version of the popular idle/incremental PokéClicker
- Host: GitHub
- URL: https://github.com/pokeclicker/pokeclicker
- Owner: pokeclicker
- Created: 2017-06-22T07:14:01.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-27T17:04:16.000Z (7 months ago)
- Last Synced: 2024-07-27T18:31:15.941Z (7 months ago)
- Topics: game, hacktoberfest, javascript
- Language: TypeScript
- Homepage: https://www.pokeclicker.com
- Size: 395 MB
- Stars: 537
- Watchers: 18
- Forks: 315
- Open Issues: 367
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[](https://github.com/pokeclicker/pokeclicker/tree/develop)
[](https://www.pokeclicker.com/)
[](https://travis-ci.com/pokeclicker/pokeclicker)
[](https://discord.gg/a6DFe4p)
# PokéClicker
A game about catching Pokémon, defeating gym leaders, and watching numbers get bigger.
You can try out the current state at https://www.pokeclicker.com/
You can reach out on discord to discuss your ideas and how to implement them: https://discord.gg/a6DFe4p
> [!NOTE]
> PokéClicker is still in development!
# Developer instructions
## Guidelines
- Make sure the build script is a success. We won't test Pull Requests that fail the building script.
- We won't accept balance Pull Requests, unless it's from a developer or Code Contributor (Discord roles).
- Pull Requests adding new translatable content should link to a Pull Request in the [translation repo](https://github.com/pokeclicker/pokeclicker-translations) adding your new strings. See the Developer instructions on that repo for more info.
- Split Pull Requests into smaller Pull Requests when possible. It will make it easier for us to review, and easier for you if something's needs to be changed or is rejected.
## Editor/IDE setup
We have an [EditorConfig](https://editorconfig.org/) and linting configured, to help everyone write similar code. You will find our recommended plugins for VSCode below, however you should be able to find a plugin for other IDEs as well.
* [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
* [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)
## Building from Source
First make sure you have git and npm available as command-line utilities (so you should install Git and NodeJS if you don't have them already).
Open a command line interface in the directory that contains this README file, and use the following command to install PokéClicker's other dependencies locally:
```cmd
npm run clean
```
Then finally, run the following command in the command line interface to start a browser running PokéClicker.
```cmd
npm start
```
> [!TIP]
> Changes to the sourcecode will automatically cause the browser to refresh.
> This means you don't need to compile TypeScript yourself. Gulp will do this for you :thumbsup:
## Use Google cloud shell _(alternative)_
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/pokeclicker/pokeclicker&git_branch=develop&page=editor&open_in_editor=README.md)
```cmd
npm clean-install
npm start
```
Click the [Web Preview](https://cloud.google.com/shell/docs/using-web-preview) Button and select port `3001` from the displayed menu.
Cloud Shell opens the preview URL on its proxy service in a new browser window.
## Deploying a new version to Github Pages
> [!IMPORTANT]
> Before deploying, check that the game compiles and starts up without errors.
Then run the following:
```cmd
npm run website
```
This will populate the `/docs` folder.
After this command completes you can now publish this to your GitHub pages branch using:
```cmd
npm run publish
```
Which by default will push to the `master` branch