lie5860 / squirdle

Squirdle, a Pokemon Wordle-like

Squirdle

Note: New features and enhancements are currently on hold while I rewrite most of this in Javascript to offset API Gateway/Lambda costs. Thanks for your patience!

A Pokémon Wordle-like, found at squirdle.fireblend.com

Featured on Kotaku, GamesRadar, Forbes, TechRadar and others!

Pokémon data based on Mario Tormo Romero's Pokemon dataset.

Pull requests welcome!

Running Locally

Requirements

• A Python 3.8+ environment

Running

1. Clone the repo and navigate inside the newly cloned directory.
2. Rename fake-daily.csv to daily.csv: mv fake-daily.csv daily.csv
3. Execute pip install -r requirements.txt to install Python dependencies.
4. Run the application with python app.py and enter the specified localhost URL.

Deploying to AWS

Requirements

• Make sure you can run the app locally first.
• An AWS account.
• AWS CLI installed & setup to use your AWS account.
• Serverless installed & setup.

Running

1. Check the serverless.yaml file for anything you might want to modify (mainly make sure the listed Python version matches your local Python version).
2. Install the required plugins into your cloned directory: npm install --save serverless-wsgi serverless-python-requirements serverless-apigw-binary.
3. Execute sls deploy and wait.

Execute sls remove to destroy the instance and all associated AWS resources.