blob: 23a4b1011fbdbe1cd77cad613db3f0c017b85c89 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
These are examples of how to setup a local development environment to add bridges, improve the docs, etc.
## Docker
The following can serve as an example for using docker:
```
# create a new directory
mkdir rss-bridge-contribution
cd rss-bridge-contribution
# clone the project into a subfolder
git clone https://github.com/RSS-Bridge/rss-bridge
```
Then add a `docker-compose.yml` file:
```yml
version: '3'
services:
rss-bridge:
build:
context: ./rss-bridge
ports:
- 3000:80
volumes:
- ./config:/config
- ./rss-bridge/bridges:/app/bridges
```
You can then access RSS-Bridge at `localhost:3000` and [add your bridge](../05_Bridge_API/How_to_create_a_new_bridge) to the `rss-bridge/bridges` folder.
If you need to edit any other files, like from the `lib` folder add this to the `volumes` section: `./rss-bridge/lib:/app/lib`.
### Docs with Docker
If you want to edit the docs add this to your docker-compose.yml:
```yml
services:
[...]
daux:
image: daux/daux.io
ports:
- 8085:8085
working_dir: /build
volumes:
- ./rss-bridge/docs:/build/docs
network_mode: host
```
and run for example the `daux serve` command with `docker-compose run --rm daux daux serve`.
After that you can access the docs at `localhost:8085` and edit the files in `rss-bridge/docs`.
|
