Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.31 KB

README.md

File metadata and controls

71 lines (47 loc) · 2.31 KB

ToMansion Pixelation

License

Code style: black Code style: flake8 code style: prettier

ci cd


Yet another r/place clone.

Screenshot

This project was made from the Vue3-FastAPI-WebApp-template, with Vue3, Phaser3, FastAPI, and Websockets.

Development Setup

Prerequisites

  • Python v3.9+ for the backend.
  • Node.js v19.0.0c and npm v8.19.2 for the frontend.
  1. Clone the repository:
git clone https://github.com/Tomansion/ToMansion-Pixelation
cd ToMansion-Pixelation
  1. Install the backend and frontend dependencies:
make install

# Or manually:
cd backend
pip install -r requirements.txt
cd ../frontend
npm install
  1. Run the backend and frontend:
make run

# Or manually:
cd backend
uvicorn websrv:app --reload --host 0.0.0.0 --port 3000
cd frontend # In another terminal
npm run serve
  1. Open the App:

Help

If you have any questions or need help, feel free to open an issue.

Contributing

I'm open to contributions and suggestions. Feel free to open an issue or a make a pull request.