From d0b3a1be355b587865371a087e34ef655cf4e57c Mon Sep 17 00:00:00 2001 From: Sieciech Date: Fri, 23 Jul 2021 18:30:38 +0000 Subject: [PATCH] Update documentation (#11) Co-authored-by: Sieciech Reviewed-on: http://git.fufle.net/Community/CureNet/pulls/11 Co-Authored-By: Sieciech Co-Committed-By: Sieciech --- README.md | 7 ++++--- src/README.md | 10 +++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 543b120..20b1922 100644 --- a/README.md +++ b/README.md @@ -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/) diff --git a/src/README.md b/src/README.md index 6e47813..7a3fcde 100644 --- a/src/README.md +++ b/src/README.md @@ -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` \ No newline at end of file +- 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 \ No newline at end of file