1
- ```
2
- _ _
3
- | | | |
4
- _ __ _ __ ___ | |_| |_ _ ______ ___ ___ _ ____ _____ _ __
5
- | '__| '_ ` _ \| __| | | | |______/ __|/ _ \ '__\ \ / / _ \ '__|
6
- | | | | | | | | |_| | |_| | \__ \ __/ | \ V / __/ |
7
- |_| |_| |_| |_|\__|_|\__, | |___/\___|_| \_/ \___|_|
8
- __/ |
9
- |___/
10
- ```
1
+ # Rmtly-Server
2
+ ![ ] ( ./.README/header.png )
11
3
12
- ## About
13
- rmtly-server is a server application written in golang that allows you to start application with a rest api
4
+ <p align =" center " >Server for remote control your pc 💻</p >
5
+
6
+ <p align =" center " >
7
+ <a href="https://github.com/free-bots/rmtly-server/releases" alt="GitHub release (latest by date)">
8
+ <img alt="GitHub" src="https://img.shields.io/github/v/release/free-bots/rmtly-server?style=flat-square"></a>
9
+ <a href="https://github.com/free-bots/rmtly-server/blob/master/LICENSE.md" alt="License">
10
+ <img alt="GitHub" src="https://img.shields.io/github/license/free-bots/rmtly-server?style=flat-square"></a>
11
+ <a href="https://github.com/free-bots/rmtly-server/graphs/contributors" alt="Contributors">
12
+ <img alt="GitHub" src="https://img.shields.io/github/contributors/free-bots/rmtly-server?style=flat-square"></a>
13
+ </p >
14
+
15
+ # Table of Contents
16
+
17
+ - [ Rmtly-Server] ( #rmtly-server )
18
+ - [ Table of Contents] ( #table-of-contents )
19
+ - [ Features] ( #features )
20
+ - [ Requirements] ( #requirements )
21
+ - [ Ubuntu] ( #ubuntu )
22
+ - [ Arch Linux] ( #arch-linux )
23
+ - [ Build] ( #build )
24
+ - [ Run] ( #run )
25
+ - [ Contribution] ( #contribution )
26
+ - [ About] ( #about )
27
+ - [ API] ( #api )
28
+ - [ Get all applications] ( #get-all-applications )
29
+ - [ Get single application] ( #get-single-application )
30
+ - [ Run an application] ( #run-an-application )
31
+ - [ Get icon of an application] ( #get-icon-of-an-application )
32
+ - [ SignUp a device] ( #signup-a-device )
33
+ - [ Configuration] ( #configuration )
34
+ - [ Default Config] ( #default-config )
35
+ - [ Mobile App] ( #mobile-app )
36
+ - [ License] ( #license )
37
+
38
+ ## Features
14
39
40
+ - List all installed applications of your pc
41
+ - List all application categories of your pc
42
+ - Start applications with or without delay
15
43
16
44
## Requirements
17
- Ubuntu
45
+ ### Ubuntu
18
46
```
19
47
sudo apt install libgtk-3-dev libcairo2-dev libglib2.0-dev libnotify-bin
20
48
```
21
- Arch Linux
49
+ ### Arch Linux
22
50
```
23
51
sudo pacman -S gtk3 libnotify
24
52
```
@@ -29,6 +57,13 @@ Run `make` or `make build` and at `<project directory>/bin` the binary called rm
29
57
## Run
30
58
After building the project run ` make run ` or open the rmtly-server file in the build directory.
31
59
60
+ ## Contribution
61
+
62
+ If you miss an important feature fell free to contribute or create a feature request.
63
+
64
+ ## About
65
+ rmtly-server is a server application written in golang that allows you to start application with a rest api
66
+
32
67
## API
33
68
### Get all applications
34
69
```
@@ -58,7 +93,7 @@ after requesting the code go to the terminal and scan the created qr code or typ
58
93
}
59
94
```
60
95
to ` http://localhost:3000/authentication/signUp `
61
- after that you get an jwt and add it to your headers for the requests
96
+ after that you get a jwt and add it to your headers for the requests
62
97
63
98
### Configuration
64
99
The config file for this server is located at ` .config/rmtly-server/config.json ` this file is auto generated if not available.
@@ -67,25 +102,22 @@ The config file for this server is located at `.config/rmtly-server/config.json`
67
102
```
68
103
{
69
104
"application": { "cacheExpiresInMillis": 10000 },
70
- "image": {
71
- "cacheExpiresInMillis": 10000,
72
- "maxImagesInCache": 100, //number of images in the cache
73
- "imageQuality": 512 // size in pixels
74
- },
75
105
"security": {
76
106
"expirationInDays": 99, // jwt expiration time
77
107
"secret": "authenticationCode",
78
- "keyFile": ""
79
108
},
80
109
"network": { "address": "0.0.0.0:3000" }
81
110
}
82
111
```
83
112
113
+ ## Mobile App
114
+ Check out [ Rmtly] ( https://github.com/free-bots/rmtly ) to control your pc with your phone.
115
+
84
116
85
117
## License
86
118
> MIT License
87
119
88
- > Copyright (c) 2020 free-bots
120
+ > Copyright (c) 2021 free-bots
89
121
90
122
> Permission is hereby granted, free of charge, to any person obtaining a copy
91
123
of this software and associated documentation files (the "Software"), to deal
0 commit comments