Skip to content

Commit

Permalink
📝 Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Draculente committed Jul 1, 2024
1 parent ebecca7 commit 17ccba2
Showing 1 changed file with 4 additions and 19 deletions.
23 changes: 4 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,12 @@
# Asteroids

Asteroids is a game where you control a spaceship and shoot asteroids. The game is written in Rust (compiled to WebAssembly), Typescript and Python in the backend.
The project is part of the modul "Webtechnologien" at the Technische Hochschule Lübeck.
Asteroids is a game where you control a spaceship and shoot asteroids. The game is written in Rust (compiled to WebAssembly) and Typescript.

## How to run locally

### Backend

The backend is written in Python and uses the [Flask](https://flask.palletsprojects.com/en/2.0.x/) framework.

Prequisites:
- Python 3.9
Deployed version: https://asteroids.draculente.eu

To run the backend, navigate to the `backend` folder and run the following commands:
```
docker compose up -d
pip install -r requirements.txt
python main.py
```

### Frontend
## How to run locally

The frontend is written in Rust and Typescript. The Rust code is compiled to WebAssembly and the Typescript code is compiled to Javascript using Webpack.
The app is written in Rust and Typescript. The Rust code is compiled to WebAssembly and the Typescript code is compiled to Javascript using Webpack.

Prequisites:
- Rust
Expand Down

0 comments on commit 17ccba2

Please sign in to comment.