Skip to content

Commit 136ae61

Browse files
authored
📑 Development guide (#9)
1 parent 5ad1803 commit 136ae61

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

‎README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,39 @@ Returns a specific client by his ID. The answer will be similar to the previous
110110

111111
Deletes a specific one client. If the client is not found, a 404 error will be returned.
112112

113+
## Development
114+
115+
### Requirements fo standalone app
116+
117+
1. wireguard + wireguard-tools
118+
2. ruby 3.3.1
119+
120+
```bash
121+
$ bundle install
122+
```
123+
124+
Run app:
125+
126+
```bash
127+
$ puma config.ru
128+
```
129+
130+
### Run with docker
131+
132+
Build image:
133+
134+
```bash
135+
$ docker build . -t wg-rest-api
136+
```
137+
138+
Run app:
139+
140+
```bash
141+
$ docker run -d -v /your_app_path:/app wg-rest-api
142+
```
143+
144+
**pre-set the necessary environment variables in the .env file**
145+
113146
## Contribution
114147

115148
If you would like to contribute to the development, submit a pull request with your changes. We welcome any contributions that improve the service. You can also view the current project board here. You can also contribute by reporting bugs or suggesting new features. Please use the GitHub issues for that.

0 commit comments

Comments
 (0)