Skip to content

Asistent utilitar care livrează alerte și notificări pentru cetățeni, în funcție de preferințe [Frontend]

License

Notifications You must be signed in to change notification settings

MariusGarbea/asistentul_cetateanului_frontend

Repository files navigation

Asistentul Cetățeanului Travis build Slack Status Known Vulnerabilities

Asistent utilitar care livrează alerte și notificări pentru cetățeni, în funcție de preferințe. La bază este un notification engine, cu un API care oferă posibilitatea de livrare de alerte din partea diverselor agenții / instituții ale statului. Aceste notificări se împart în cele cu caracter general (care sunt de interes pentru mai mulți cetățeni, cum ar fi alertele meteo) sau cu caracter personal (care sunt de interes pentru un singur cetățean, cum ar fi cele legate de expirarea documentelor). Mai multe detalii pe wiki.

Requirements

Instalare

Crează un cont pe Auth0 și de un client tip Single Page Application, vei avea nevoie de Client ID și Domain mai târziu (le găsești în setările clientului pe Auth0).

$> git clone https://github.com/gov-ithub/asistentul_cetateanului_frontend.git
$> cd asistentul_cetateanului_frontend
$> cp .env_template .env
$> vim .env // înlocuiește credențialele false cu ale tale

Dacă vrei să folosești Docker:

$> docker build -t asistentul_cetateanului .
$> docker run -d -p 80:3000 --name asistentul_cetateanului_inst asistentul_cetateanului
$> // Aplicatia va rula pe localhost, portul nu trebuie specificat (80)

Pentru a opri containerul:

$> docker ps // vezi running containers, copiaza hash pentru Asistentul Cetateanului
$> docker stop _HASH_

Pentru a rula comenzi în container:

// $> docker exec asistentul_cetateanului [CMD]
$> docker exec asistentul_cetateanului npm test

Dacă nu vrei să folosești Docker

$> npm install
$> npm start

Tehnologii folosite

[1] Posibil să se schimbe în viitorul apropiat
[2] Auth0 e doar o soluție temporară. Aveți nevoie de cont pe Auth0 și un Single Page client pentru a testa/dezvolta local.

Contribuie

Dacă vrei să contribui - ești binevenit(ă) - but we don't have cookies (yet)

Proces

  • Vezi lista de tehnologii folosite - îți sunt familiare?
  • Dacă nu ești încă înscris(ă) în comunitate, te rog fă-o pe site-ul GovITHub
  • Aruncă o privire la guidelines pentru code review
  • Caută în issues un task interesant pentru tine (sau, dacă ai o propunere, deschide un issue / trimite un pull request). Task-urile care nu sunt up-for-grabs sunt marcate ca atare.
  • După ce trecem prin code review - celebrate! ⭐ 🌟 ⭐

Pro tips

Testing

Rulează npm test. npm test rulează doar testele nou introduse, de la ultimul commit, by default, însă vă permite rularea tuturor testelor (you`ll know what to do when you see it).

Ca și framework folosim Jest. Documentație mai completă >>

Development

  • npm start: Servește aplicația pe portul 3000
  • npm run build: Pregătește aplicația pentru deployment (include minification, bundling, etc)
  • npm run eject: Elimină dependența de create-react-app. Poate va fi necesar, dar până atunci please don't touch.

Pull Request cheat-sheet

  • Ai un summary complet? Trebuie să fie clar: ce schimbare aduce diff-ul, cum ai testat, și în cazuri unde se fac schimbări majore, dacă e cazul, avem un revert plan?
  • Ai scris teste pentru codul nou adăugat/modificat?
  • Ai făcut un self review pe propriul diff urmărind guidelines?

Dacă răspunsul e "da" pentru toate 3, procesul de code review ar trebui să fie destul de painless, nice work.

Pull Requests > Issues

Preferă pull request-uri peste issues unde e posibil, pull request-urile sunt primite cu brațele deschise oricând.

Known issues

npm test poate da fail având în vedere numărul de fișiere watch-uite, se poate rezolva pe Linux cu:

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

Cum poti intra in contact cu echipa?

Mai multe detalii în curând!


Made with ❤️ by GovITHub

About

Asistent utilitar care livrează alerte și notificări pentru cetățeni, în funcție de preferințe [Frontend]

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •