https://github.com/Eoic/Canopy
Create and engage in discussions to grow the infinite virtual forest.
https://github.com/Eoic/Canopy
chatapp fastapi forum javascript pixijs python sqlmodel typescript virtual-forest
Last synced: 2 months ago
JSON representation
Create and engage in discussions to grow the infinite virtual forest.
- Host: GitHub
- URL: https://github.com/Eoic/Canopy
- Owner: Eoic
- Created: 2024-10-13T16:26:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-23T22:18:38.000Z (over 1 year ago)
- Last Synced: 2024-10-24T10:39:08.622Z (over 1 year ago)
- Topics: chatapp, fastapi, forum, javascript, pixijs, python, sqlmodel, typescript, virtual-forest
- Language: TypeScript
- Homepage:
- Size: 254 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rustle
Create and engage in real-time discussions to grow the infinite virtual forest. While of potentially little practical value, this is an experiment on applying various networking-related solutions such as real-time chat, multiplayer cursors, infinite grid, spatial partitioning (for network event processing in visible area), and so on.
## Development
### Client
1. Install dependencies:
```
npm ci
```
2. Copy `.env.example` to `.env` and set the required environment variables.
3. Start the development server:
```
npm run dev
```
4. By default, the client runs on [http://127.0.0.1:5173/](http://127.0.0.1:5173/).
See [package.json](./package.json) for linting and build commands.
### Server
1. Change the directory to `server/`.
2. Create a virtual environment and install dependencies:
```
python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
```
3. Run the server:
```
./run.sh
```
4. By default, the server runs on [http://127.0.0.1:8000/](http://127.0.0.1:8000/).