Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pokedextracker/pokedextracker.com
A website to track your completion of a Living Pokedex.
https://github.com/pokedextracker/pokedextracker.com
pokemon react redux
Last synced: 3 months ago
JSON representation
A website to track your completion of a Living Pokedex.
- Host: GitHub
- URL: https://github.com/pokedextracker/pokedextracker.com
- Owner: pokedextracker
- License: mit
- Created: 2016-03-14T03:26:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-20T21:11:30.000Z (10 months ago)
- Last Synced: 2024-07-18T12:11:31.814Z (4 months ago)
- Topics: pokemon, react, redux
- Language: SCSS
- Homepage: https://pokedextracker.com
- Size: 23.5 MB
- Stars: 167
- Watchers: 10
- Forks: 42
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Support: SUPPORTERS.md
Awesome Lists containing this project
README
# pokedextracker.com
[](https://circleci.com/gh/pokedextracker/pokedextracker.com)
[](https://david-dm.org/pokedextracker/pokedextracker.com)
A website to track your completion of a Living Pokedex.
## Install
This project has been tested to work with Node.js v5 (at least v5.10) and v6 (though it might work for other versions), so make sure you have one of them installed and active when running this application. This project also relies on the `yarn.lock` file to lock down dependency versions, so we recommend that you use [`yarn`](https://yarnpkg.com/en/) instead of `npm` to avoid "it works on my computer" bugs that are all too common with just a `package.json`.
### Unix
When on Linux or Mac OS X, we recommend using [`nvm`](https://github.com/creationix/nvm) so that you can easily switch between Node versions. This is so that they don't conflict with each other when working on different Node projects.
```sh
$ nvm install 5
$ nvm use 5
$ yarn
```
If you have [`avn`](https://github.com/wbyoung/avn) or [`nodenv`](https://github.com/nodenv/nodenv) setup, the `.node-version` file should automatically switch the version for you.
Keep in mind though that `nvm` is not required to run this application.
### Windows
While there is [`nvm` for Windows](https://github.com/coreybutler/nvm-windows), we've seen some people having issues with later versions of Node. So instead, it might just be easier to install Node using the [Windows Installer](https://nodejs.org/en/download/current/). Once you have Node installed, then you should be able to just install the dependencies.
```dos
> yarn
```
## Running
To run the development server to test it locally, you only need to run:
```sh
$ yarn start
```
Once the bundle becomes valid, you should be able to go to [http://localhost:8080](http://localhost:8080) to view it.
## Linting
To ensure your files are following the preferred style guide, you can run:
```sh
$ yarn run lint
```
This is run on Travis whenever a commit is made so if you're going to [contribute](CONTRIBUTING.md), you should make sure your files pass the linter.
## Docker
Every merge into the `master` branch on GitHub triggers a new build for a Docker image. That image will overwrite the `latest` tag, and there will be an explicit tag with the first 7 characters of the commit hash. The server will be listening on port 4939 so if you run a container locally, make sure that traffic is forwarded to that port. For example:
```sh
$ docker run --rm --publish 3000:4939 --name pokedextracker pokedextracker/pokedextracker.com:latest
```
## Deployments
>Note: you need the necessary permissions to be able to deploy.
The [deploy script](script/deploy.sh) uses [Helm](https://helm.sh/) and the
[`web-app` Helm
chart](https://github.com/pokedextracker/charts/tree/master/src/web-app) to
create a new release in the PokedexTracker Kubernetes cluster. Pass in the
newly created Docker tag to deploy that version to the cluster.
```sh
$ yarn deploy:staging 123abcd
$ yarn deploy:production 123abcd
```