Skip to content

Commit 4a29b5b

Browse files
committed
Add README and compose.yaml
1 parent 98a5fe8 commit 4a29b5b

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# GräddIT
2+
3+
Calculator website for calculating the ingredients of turquoise whipped cream
4+
like [P.R.I.T.](https://prit.chalmers.it) makes.
5+
6+
## Deployment
7+
8+
### Using Docker run
9+
10+
```console
11+
docker run -p "8080:8080" ghcr.io/olillin/graddit:latest
12+
```
13+
14+
### Using Docker Compose
15+
16+
See [`compose.yaml`](./compose.yaml) for an example.
17+
18+
## Development
19+
20+
Thank you for wanting to contribute! GraddIT is written in plain JavaScript, so
21+
to start the server simply run:
22+
23+
```console
24+
node .
25+
```
26+
27+
All files are served statically from [`public/`](./public).
28+

compose.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# This compose file shows how to deploy the service in production
2+
3+
name: graddit
4+
5+
services:
6+
server:
7+
image: ghcr.io/olillin/graddit
8+
restart: unless-stopped
9+
ports:
10+
- "8080:8080"
11+

0 commit comments

Comments
 (0)