Skip to content
This repository has been archived by the owner on Jan 1, 2023. It is now read-only.

TheGreaterHeptavirate/ConstiTutor

Repository files navigation

NOTE

Dear Users/visitors Since the fact that at december 2022 HackHeroes has finished, and the project didn't win anything, as well as because of lack of interesst in further development, We've decided to announce its end-of-life. If you're interessted in resuming the development anyhow, feel free to contact us for details.

Thanx! gucio321 gucio321@users.noreply.github.com - the Head Developer.

ConstiTutor jest aplikacją, tworzoną do udziału w Ogólnopolskim konkursie programistycznym Hack Heroes

Aplikacja służy do wyszukiwania interesującej użydkownika frazy w Konstytucji Rzeczypospolitej Polskiej oraz innych aktach prawnych.

Akty prawne

Obecnie, aplikacja pozwala na wyszukiwanie w następujących aktach prawnych:

  • Konstytucja Rzeczypospolitej Polskiej

Instrukacja instalacji

aby uruchomić program musisz zainstalować kilka komponentów:

  1. golang
  2. Przejdź do strony frameworku giu i zainstaluj wymagane aplikacje
  3. zainstaluj zależności wymagane do uruchomienia oto
  4. pobierz kod źródłowy:
git clone https://github.com/TheGreaterHeptavirate/constitutor
  1. W konsoli wejdź do katalogu projektu i zainstaluj zależności
cd constitutor
go get -d ./...

teraz, aby uruchomić program wystarczy wykonać następującą komendę:

go run cmd/constitutor/main.go

Na systemie operacyjnym Linux możesz również spróbować użyć komendy make. Obsługiwane komendy:

  • make setup
  • make build
  • make run
  • make test - uruchomienie testów jednostkowych (unit testów)
  • make cover - utworzenie raportu o skuteczności testów jednostkowych
  • make clean
  • make help

Design doc

TASKLIST

  • stworzenie bazy JSONowej dla ustaw (najpierw konstytucji, potem może też do innych ustaw)

więcej informacji

  • system wejścia (pkg/core/data)

konwerter jsona do GO

  • UI

Użycie frameworku giu. Można rozważyć fyne, gdyż jest kompatybilna z androidem.

UWAGA! Stosujemy nieoficialną konwencją struktury projektu GO!