README.md 1.78 KB
Newer Older
1
# schleuder-web, a web interface for Schleuder3
2

paz's avatar
paz committed
3
This is a full featured web interface to administrate [Schleuder v3](https://0xacab.org/schleuder/schleuder)-lists and subscriptions.
paz's avatar
paz committed
4

5
6
##  Installation

paz's avatar
paz committed
7
8
9
10
11
12
13
14
15
Make sure you have these libraries installed:

* libxml2
* zlib
* sqlite3 (or your DMBS of choice)

On a Debian-system, run e.g. this: `apt install libxml2-dev zlib1g-dev libsqlite3-dev`.


paz's avatar
paz committed
16
17
18
19
20
21
22
23
### To have a glimpse

1. ./bin/setup
1. ./bin/start
1. Visit http://localhost:3000/

### To run productively

24
25
1. Mandatory: In `config/secrets.yml` change `secret_key_base` or set the environment variable SECRET_KEY_BASE.
1. Mandatory: In `config/schleuder-web.yml` add `tls_fingerprint` and `api_key` (get them from the admins that run Schleuder's api-daemon). You can also set them through the environment variables SCHLEUDER_TLS_FINGERPRINT and SCHLEUDER_API_KEY.
paz's avatar
paz committed
26
27
28
1. Optional: edit `config/database.yml`.
1. `bundle install --without development`.
1. `bundle exec rake db:setup RAILS_ENV=production`.
29
1. Run `RAILS_ENV=production bundle exec rake assets:precompile` to precompile all images and css files.
paz's avatar
paz committed
30
1. Setup mod_passenger, or a proxy + `bundle exec rails server -e production`.
31

paz's avatar
paz committed
32
33
34

## Usage

paz's avatar
paz committed
35
1. Log into the webinterface with email "root@localhost" and password "slingit!".
36
37
38
39
40
41


## TODO

See also `rake notes`

Nina's avatar
Nina committed
42
## Testing
Nina's avatar
Nina committed
43

Nina's avatar
Nina committed
44
45
46
47
48
49
50
We use rspec to test our code. To execute the test suite run:

```
bundle exec rspec
```

We are working on extendig the test coverage.
51

Nina's avatar
Nina committed
52
53
54
55
## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md).

georg's avatar
georg committed
56
57
58
59
## Mission statement

Please see [MISSION_STATEMENT.md](MISSION_STATEMENT.md).

Nina's avatar
Nina committed
60
61
62
63
## Code of Conduct

We adopted a code of conduct. Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

64
65
66
## License

GNU GPL version 3.
paz's avatar
paz committed
67
68
69
70
71

## Screenshot

![Screenshot of schleuder-web](doc/schleuder-web-screenshot.png)