Update documentation (#11)

Co-authored-by: Sieciech <www.sieciech@gmail.com>
Reviewed-on: http://git.fufle.net/Community/CureNet/pulls/11
Co-Authored-By: Sieciech <sieciech@noreply.fufle.net>
Co-Committed-By: Sieciech <sieciech@noreply.fufle.net>
This commit is contained in:
Michał Sieciechowicz 2021-07-23 18:30:38 +00:00
parent 8ec9ff4dc7
commit d0b3a1be35
2 changed files with 11 additions and 6 deletions

View File

@ -12,7 +12,7 @@ We also encourage doctors and specialists to join the community, they will have
### Disease analysis
We want users to have access to the log of their disease where they can enter how it is progressing. On this basis, together with specialists, we will be able to find some common features for new diseases and predict as many negative symptoms as possible in order to be able to prevent them as much as possible.
[Technical documentation](./src/)
[Technical documentation](./src/#c#technical-documentation)
# Polski
## Czym jest CureNet?
@ -26,6 +26,7 @@ Każdy może założyć profil oraz dodać jedną lub więcej chorób. Dzięki t
### Społeczność specjalistów
Zachęcamy także lekarzy i specjalistów, aby dołączyli do społeczności, będą oni mieli wgląd w listę swoich pacjentów ale także do listy osób, które mają podobne schorzenia jak ich podopieczni, dzięki czemu będą mieli dostęp do szerszego grona osób z daną chorobą. Będą mogli także przedyskutować swoje obserwacje z innymi lekarzami, którzy także mają doświadczenie z daną chorobą. Jest to naprawdę ważne przy bardzo unikalnych i nie dokońca poznanych jeszcze schorzeniach.
### Analiza chorób
Chcemy, aby użytkownicy mieli dostęp do dzinnika swojej choroby, gdzie będą mogli wprowadzać jak ona przebiega. Na tej podstawie wraz ze specjalistami będziemy w stanie znaleźć pewne wsólne cechy dla nowych chorób i przewidzieć jak najwięcej negatywnych symptomów, aby móc im jak najlepiej zapobiec.
Chcemy, aby użytkownicy mieli dostęp do dziennika swojej choroby, gdzie będą mogli wprowadzać jak ona przebiega. Na tej podstawie wraz ze specjalistami będziemy w stanie znaleźć pewne wsólne cechy dla nowych chorób i przewidzieć jak najwięcej negatywnych symptomów, aby móc im jak najlepiej zapobiec.
[Dokumentacja techniczna](./src/#c#technical-documentation)
[Dokumentacja techniczna](./src/)

View File

@ -26,7 +26,7 @@
- [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools)
- [SQLTools PostgreSQL/Redshift Driver](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools-driver-pg)
- Plugins for git:
1. [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
- [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
## How to run app?
1. Download project from repository using standalone git or built in any IDE
@ -56,7 +56,7 @@
6. Enter username: `postgres`
7. Enter password: `WeryStronkPaz2`
8. Save it
9. Go to Servers > [you name] > Databases > curenet > Schemas > public > Tables
9. Go to Servers > [your name] > Databases > curenet > Schemas > public > Tables
10. You can see all tables
### Database
- Server: `localhost`
@ -67,4 +67,8 @@
- Database
- For application: `curenet`
- For admin: `postgres`
- Password: `WeryStronkPaz2`
- Password: `WeryStronkPaz2`
### Known issues
1. If the docker build the app but can't run it, check the docker/startup.sh file, it should be saved with LF as end of line sequence. If it's CRLF try to change it to LF, save the file and try to run app again