README.md 1.24 KB
Newer Older
Robert Czechowski's avatar
Robert Czechowski committed
1
2
# The Medal Contest Platform

3
![buildstatus](https://git.bwinf.de/zgtm/medal-prototype/badges/master/build.svg) [![forthebadge](https://forthebadge.com/images/badges/fuck-it-ship-it.svg)](https://forthebadge.com)
4

Robert Czechowski's avatar
Robert Czechowski committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Medal is a small platform for in-browser running contest written in rust.

It is designed for the German Jugendwettbewerb Informatik, a computer science contest with tasks using Google Blockly as a programming language-replacement.




## Translation




## Folder structure

### tasks/


## Running Medal
23
24
25

Needs `rustc` 1.28 (stable) or higher (cf. https://rustup.rs/). 

26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Running 
```
make
```
compiles and runs a debug-/test-server.

For production use, a release binary should be compiled and served behind a reverse proxy (nginx, apache, …). 
```
make release
```
compiles a release build with openssl statically linked for distribution.

The directories `tasks/` and `static/` can (and for throughput-purposes should) be served by the reverse proxy directly.

## Contributing

Please format your code with `rustfmt` and check it for warnings with `clippy`.

You can install those with 
```
46
rustup component add rustfmt --toolchain nightly
47
48
49
50
51
rustup component add clippy
```

Format the code and check for warnings with
```
52
make format
53
54
make clippy
```
55