README.md

OpenAssets project

Forms to digitalize Assets Declaration from Members of Parlament

Application runs under: http://openassets.herokuapp.com/

API

Aplikacja udostępnia REST API do przeglądania już przepisanych dokumentów

http://openassets.herokuapp.com/rest/transcriptions/count

Wyświetla sumaryczną informację o ilości przepisanych dokumentów.

http://openassets.herokuapp.com/rest/transcriptions/<dokument_id>

Wyświetla wszystkie przesłane transkrypcje wybranego dokumentu.

Zależności

Projekt używa mongodb to przechowywania danych. Konfiguracja bazy opiera się na zmiennej systemowej MONGOHQ_URL

mongodb://<user>:<pass>@<host>:<port>/<collection> 

Jeżeli zmienna nie jest ustawiona przymowana jest wartość domyślna:

mongodb://localhost/hackaton

Import bazy danych komendą mongoimport -c documents /sciezka/do/pliku/import.json Plik import.json generowany jest na podstawie danych z serwisu sejmometr.pl. Najnowsze dane można wygenerować za pomocą API i skryptu mongo/import.php.

Uruchomienie projektu lokalnie

Po uruchomieniu i skonfigurowaniu MongoDB, uruchamiany serwer

mvn jetty:run

Strona dostępna jest pod adresem: http://localhost:8080/

Uruchomienie projektu na heroku

Zgodnie z instrukcjami: https://devcenter.heroku.com/articles/getting-started-with-java#deploy-your-application-to-heroku https://devcenter.heroku.com/articles/mongohq#use-with-java

1. Utwórz aplikację na heroku

heroku apps:create <nazwa>

2. Dodaj obsługę bazy MongoDB (do tego potrzeba jest zweryfikowanego konta: https://devcenter.heroku.com/articles/account-verification)

heroku addons:add mongohq:sandbox

Infomacje o bazie (także connection string) można zobaczyć wydając komendę

heroku addons:open mongohq

W przeglądarce zostanie otwarta pełna informacja nt. bazy

3. Załaduj przykładowe dane do bazy. Zgodnie z opisem: https://devcenter.heroku.com/articles/mongohq#upgrading-your-database. Zamiast mongorestore importujemy zawatość pliku init_import.json mongoimport -c documents -h <hostname>.mongohq.com:<port> -d <baza_danych> -u <username> -p <haslo> /sciezka/do/pliku/import.json Login i hasło do instancji mongodb na heroku dostępne przekazywane jest poprzez zmienną środowiskową MONGOHQ_URL. Aby wyświetlić wartość zmiennych dla instancji heroku wpisz heroku config

4. Dodaj nowy git remote

git remote add heroku [email protected]:<nazwa>.git

5. Wyślij aplikację

git push heroku master

6. Otwórz aplikację w przeglądarce

heroku open