Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smasher164/pokemonstay
Collect, train, and trade your favorite Pokémon!
https://github.com/smasher164/pokemonstay
Last synced: about 2 months ago
JSON representation
Collect, train, and trade your favorite Pokémon!
- Host: GitHub
- URL: https://github.com/smasher164/pokemonstay
- Owner: smasher164
- License: mit-0
- Created: 2019-09-20T06:47:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T23:59:27.000Z (9 months ago)
- Last Synced: 2024-04-17T04:54:27.099Z (9 months ago)
- Language: Python
- Homepage: https://www.stay.akhil.cc/
- Size: 341 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pokémon Stay
This repository holds the source for the Pokémon Stay group project for CS 3250. Local development and builds can be done with
```
$ ./stay start app --port=[PORT] --debug=[DEBUG] --dbhost=[DB_HOST] --dbname=[DB_NAME] --dbuser=[DB_USERNAME] --dbpass=[DB_PASSWORD]
```
Most flags are optional, so you can simply run it with
```
$ ./stay start app --dbpass=[DB_PASSWORD]
```
The process can be shut down via
```
$ ./stay stop app
```
If the correct version of python and its dependencies are installed, run it locally without Docker via
```
$ ./stay start debug --dbpass=[DB_PASSWORD]
```
### Development
For development builds to mirror the production environment, [Docker](https://www.docker.com/) should be installed on your local machine. Otherwise, simply use the debug command listed above, Additionally, the shell script assumes that Unix shell commands can be run on your system. This can be updated to accomodate Windows users, but a Unix-like environment would be preferrable.
Installing Docker:
- MacOS users: Install [Docker Community Edition (CE) for Mac](https://docs.docker.com/v17.12/docker-for-mac/install/)
- Linux users: Install [Docker Community Edition (CE) for your distro](https://docs.docker.com/v17.12/install/#server)
- Windows users: (Please file an issue if you encounter any problems with the process below)
1. Install the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to set up a Unix-like environment on your system.
2. [Install WSL2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install) for full system-call compatibility.
3. Install [Docker for WSL2](https://docs.docker.com/docker-for-windows/wsl-tech-preview/).
### Deployment
This repository is set up to deploy on commit to master. The deployment process's log can be observed under the "Production Deployment" workflow in the Actions tab of the repo.
The Docker image we are currently using is based on the latest Python 3.8 as well as Alpine Linux 3.10.