Skip to content

Latest commit

 

History

History
99 lines (80 loc) · 3.88 KB

README.md

File metadata and controls

99 lines (80 loc) · 3.88 KB
Raw

pir-medl

Dette skal bli en kjapp og grei løsning på en medlemsdatabase som til å begynne med skal brukes internt i Piratpartiet. Ny funksjonalitet vil legges til etterhvert. Siden dataene blir lagret i en SQLite-database, er det fort gjort å lage små scripts som lager rapporter eller oppdaterer databasen på en enkel og fleksibel måte.

Kommentarer og pullrequester er selvfølgelig veldig gode ting, spesielt hvis noen ser at det går galt avgårde. For å holde kommunikasjonen samlet, er det sikkert best å åpne en issue på Gitlab hvis det er noe som kommer opp. Eller Github, hvis du liker å henge rundt der istedenfor. Begge repoene på Gitlab og Github blir oppdatert samtidig.

Status

Har satt opp forslag til databasestruktur og har startet på medl. Foreløpig skjønner den disse kommandoene:

  • medl diag
  • medl init

Til å begynne med blir det en kommandolinjeklient, men det kan klaskes på GUI, ncurses og/eller webgrensesnitt etterhvert. Det skal også kunne brukes som et API der medl mottar kommandoer i form av JSON fra stdin, gjør sine ting og leverer respons og data som JSON til stdout.

Saken skrives i C, bruker C89 for å få det portabelt. Det skal være mulig å kompilere på (GNU/)Linux, alt av BSD-er, MS Windows og den der Mac-tingen.

Det skal gå an å få noe med enkel funksjonalitet på plass i løpet av noen dager. Det vil ikke være behov for en egen server å kjøre dette på, alle som bruker databasen kjører programmet lokalt på egen PC og får en lokal kopi av databasen som de kan jobbe med. Som en bonus fungerer disse kopiene som backuper i tilfelle den sentrale repoen går gaiki.

Denne distribueringen bruker Git under panseret, men brukeren trenger ikke å ha noe med Git å gjøre. All syncing foregår automatisk, og det klages bare hvis det oppstår en mergekonflikt. Databasen blir dermed også versjonskontrollert i Git med full historie, og alle forandringer i databasen blir lagret med SHA1, tidspunkt og brukernavn.

Programmet kan selvfølgelig også kjøres på en server der alle som trenger det har tilgang, hvis det er ønskelig.

make-kommandoer

Disse make-kommandoene er tilgjengelige:

  • make
    Kompiler tingene i src/ og lag README.html.
  • make clean
    Slett alle genererte filer og sett alt tilbake til en jomfruelig tilstand.
  • make test
    Kjør diverse tester for å se at systemet fungerer greit nok. Sjekker også at alle forutsetninger er til stede, som f.eks. installert programvare osv.
  • make valgrind
    Kjør make test og bruk Valgrind. Tar mye lengre tid enn make test, men den tar det meste av tvilsomme ting.
  • make edit
    Rediger alle filene i repoen. Bruker favoritteditoren din, det vil si den som er definert i EDITOR.
  • make README.html
    Generer README.html fra README.md. Trenger cmark(1) fra http://commonmark.org. Gjøres automatisk av make.
  • make view
    Kjør make README.html og vis den med lynx(1) for å se at alt ser greit ut.

Lisens

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

File ID: e1eeeb4e-38b5-11e7-a4b8-f74d993421b0
vim: set et fenc=utf8 fo=clnqtw sts=2 sw=2 ts=2 tw=72 :