codeforleipzig/stadtratmonitor
codeforleipzig/stadtratmonitor
1
1
Fork 0
mirror of https://github.com/CodeforLeipzig/stadtratmonitor.git synced 2025-04-04 09:46:43 +02:00
Code Issues Projects Releases Packages 4 Wiki Activity

improve README.md

Browse source
This commit is contained in:
Vri 🌈 2023-05-10 21:43:44 +02:00
parent 47a2e8b410
commit 441f8f08e3
Signed by: vrifox
GPG key ID: D40098E5B60B2197
1 changed files with 10 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -1,9 +1,8 @@
# Stadtratmonitor # Stadtratmonitor
**Offical site:** https://stadtratmonitor.leipzig.codefor.de/ **Offical site:** [stadtratmonitor.leipzig.codefor.de](https://stadtratmonitor.leipzig.codefor.de/)
## Usage / Features ## Usage / Features
The Stadtratmonitor Leipzig is a lightweight user interface for performing full text searches against paper contents issued to the city council of Leipzig. Note, this solution uses the data from [Ratsinformationssystem Leipzig](https://ratsinformation.leipzig.de/allris_leipzig_public/) that also offers [text search capabilities](https://ratsinformation.leipzig.de/allris_leipzig_public/vo040). The Stadtratmonitor Leipzig is a lightweight user interface for performing full text searches against paper contents issued to the city council of Leipzig. Note, this solution uses the data from [Ratsinformationssystem Leipzig](https://ratsinformation.leipzig.de/allris_leipzig_public/) that also offers [text search capabilities](https://ratsinformation.leipzig.de/allris_leipzig_public/vo040).
### Sorting ### Sorting
@ -47,7 +46,6 @@ Create a new Feed in RSSOWL and paste the just copied URL in the form
When updating the feed in RSSOWL (or any other RSS reader of your choice) time after time all new papers matching the search query criteria will appear. When updating the feed in RSSOWL (or any other RSS reader of your choice) time after time all new papers matching the search query criteria will appear.
## Setup ## Setup
There are two ways to run this app: using a local development setup, or using There are two ways to run this app: using a local development setup, or using
docker. docker.
@ -55,36 +53,21 @@ docker.
1. Install Ruby, Bundler, Elasticsearch 1. Install Ruby, Bundler, Elasticsearch
2. Start Elasticsearch: `elasticsearch` 2. Start Elasticsearch: `elasticsearch`
3. Setup Rails app: `bundle && bundle exec rake db:setup` 3. Setup Rails app: `bundle && bundle exec rake db:setup`
4. See "Importing data" below 4. See “[Importing data via Allris Scraper](#importing-data-via-allris-scraper-optional)” below
5. Start Rails server: `bundle exec rails s` 5. Start Rails server: `bundle exec rails s`
6. Open [http://localhost:3000](http://localhost:3000) 6. Open [localhost:3000](http://localhost:3000)
### Using docker ### Using Container (Docker/Podman/…)
1. [Install Docker and Docker Compose](https://docs.docker.com/compose/install/)
1. Install docker and docker-compose: https://docs.docker.com/compose/install/ 2. Start the application: `docker-compose up`
2. Start the app: `docker-compose up`
3. Initialize the database: `docker exec stadtratmonitor-web sh -c "rake db:setup && rake import_papers && rake index:rebuild"` 3. Initialize the database: `docker exec stadtratmonitor-web sh -c "rake db:setup && rake import_papers && rake index:rebuild"`
4. Open [http://localhost:3000](http://localhost:3000) 4. Open [localhost:3000](http://localhost:3000)
``` ### Importing data via Allris Scraper (optional)
rake assets:clean 1. You can use [our Allris Scraper](https://github.com/CodeforLeipzig/allris-scraper) to download the papers (resp. their links) from the [OPARL](https://oparl.org/) API, this will produce an input.json file
rake assets:clobber
rake tmp:clear
npm install -g sass
#rails css:install:bootstrap
#rails javascript:install:esbuild
rake assets:precompile
```
### Importing data via allris-scraper (optional)
1. You can use [our allris-scraper](https://github.com/CodeforLeipzig/allris-scraper) to download the papers (resp. their links) from the [OPARL](https://oparl.org/) API, this will produce an input.json file
2. Put this input.json to a public web server and set the URL to this file then in: 2. Put this input.json to a public web server and set the URL to this file then in:
`app/controllers/import_controller.rb` and `lib/tasks/import_papers.rake` `app/controllers/import_controller.rb` and `lib/tasks/import_papers.rake`
### Running tests ### Running tests
Assuming docker and docker-compose is installed: Assuming docker and docker-compose is installed:
1. `docker-compose run web bin/run-tests`
1. `docker-compose run web bin/run-tests`