@@ -2,41 +2,43 @@ aw-server-rust
2
2
==============
3
3
4
4
[ ![ Dependency Status] ( https://deps.rs/repo/github/activitywatch/aw-server-rust/status.svg )] ( https://deps.rs/repo/github/activitywatch/aw-server-rust )
5
- [ ![ Build Status] ( https://travis-ci.org/ActivityWatch/aw-server-rust.svg?branch=master )] ( https://travis-ci.org/ActivityWatch/aw-server-rust )
6
- [ ![ Coverage Status] ( https://codecov.io/gh/ActivityWatch/aw-server-rust/branch/master/graph/badge.svg )] ( https://codecov.io/gh/ActivityWatch/aw-server-rust )
5
+ ![ Build Status] ( https://github.com/ActivityWatch/aw-server-rust/workflows/Rust/badge.svg )
7
6
8
- A reimplementation of aw-server in Rust
7
+ [ ![ Coverage Status ] ( https://codecov.io/gh/ActivityWatch/ aw-server-rust/branch/master/graph/badge.svg )] ( https://codecov.io/gh/ActivityWatch/aw-server-rust )
9
8
10
- Primary features missing:
11
- - None?
9
+ A reimplementation of aw-server in Rust.
12
10
13
11
Caveats:
14
- - Lots of TODO and FIXME comments
15
12
16
- Bugs:
17
- - Memory leak during Bucket import? (wtf rust?)
13
+ - Lots of TODO and FIXME comments
14
+
15
+ Features missing compared to the Python implementation of aw-server:
18
16
19
- Features missing compared to aw-server python:
20
- - Swagger support
17
+ - API explorer (Swagger/OpenAPI)
21
18
22
19
### How to compile
23
20
24
- Install rust nightly with rustup
21
+ Install rust nightly with ` rustup ` :
25
22
26
- ``` rustup default nightly ```
23
+ ```
24
+ rustup default nightly
25
+ ```
27
26
28
- Run cargo build to build
27
+ Build with ` cargo ` :
29
28
30
- ``` cargo build --release ```
29
+ ```
30
+ cargo build --release
31
+ ```
31
32
32
- ### How to run
33
+ Your built executable will be located in ` ./target/release/aw-server-rust `
33
34
34
- After compilation you will have an executable at target/release/aw-server-rust
35
35
36
- ``` ./target/release/aw-server-rust ```
36
+ ### How to run
37
37
38
- If you want to quick-compile for debugging, run cargo run from the project root
38
+ If you want to quick-compile for debugging, run cargo run from the project root:
39
39
40
- * NOTE:* this will start aw-server-rust on the testing port 5666 instead of port 5600
40
+ ```
41
+ cargo run --bin aw-server
42
+ ```
41
43
42
- ``` cargo run ```
44
+ * NOTE: * This will start aw-server-rust in testing mode (on port 5666 instead of port 5600).
0 commit comments