Garden Palooza

A multiplayer gardening game: https://gardenpalooza.tech

Installation

Docker

Make sure you have the docker daemon installed and running, and docker-compose installed.

Create a .env file using the example.env template.

For development, run docker-compose -f docker-compose.yml -f docker-compose-dev.yml build

---

Manual

For the server, you'll need python3 and pip

For developing the React app, you'll need create-react-app, or at least npm

Server

Switch to the server/ directory

Create and activate virtual environment using virtualenv.

$ python3 -m venv python3-virtualenv
$ source python3-virtualenv/bin/activate

Use the package manager pip to install all dependencies

pip install -r requirements.txt

React App

Install JavaScript dependencies

$ npm install package.json

Usage

Docker

For development, run docker-compose -f docker-compose.yml -f docker-compose-dev.yml up

---

Manual

Game Server

Make sure you have a Postgres instance running, and configure your .env file to use it using the example.env template.

Source the virtualenv.

Start the server

gunicorn --worker-class geventwebsocket.gunicorn.workers.GeventWebSocketWorker -w 1 app:app --bind=0.0.0.0:5000 --reload

React App

Start React development server with npm run start

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.