Community
/
CureNet
2
1
Fork 0
Code Issues 1 Pull Requests 1 Projects 1 Releases Wiki Activity

Update documentation #8

Merged
Sieciech merged 3 commits from 6-update-documentation into dev 2021-07-23 18:05:10 +00:00
Conversation 0 Commits 3 Files Changed 2 +75 -1
2 changed files with 75 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -12,6 +12,8 @@ We also encourage doctors and specialists to join the community, they will have
### Disease analysis ### 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. 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/)
# Polski # Polski
## Czym jest CureNet? ## Czym jest CureNet?
### Opis ### Opis
@ -25,3 +27,5 @@ Każdy może założyć profil oraz dodać jedną lub więcej chorób. Dzięki t
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. 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 ### 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 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.
[Dokumentacja techniczna](./src/)

70
src/README.md Normal file
View File

@ -0,0 +1,70 @@
# Technical documentation
## Frontend
1. [HTML 5](https://developer.mozilla.org/en-US/docs/Glossary/HTML5)
1. [CSS 3](https://developer.mozilla.org/pl/docs/Web/CSS)
1. [JavaScript](https://developer.mozilla.org/pl/docs/orphaned/Web/JavaScript)
1. [TypeScript](https://www.typescriptlang.org/docs/ "Documentation")
1. [Angular 12](https://angular.io/docs "Documentation") (Frontend framework)
## Backend
1. [PHP 8.0](https://www.php.net/docs.php "Documentation")
1. [Symfony 5](https://symfony.com/doc/current/index.html "Documentation") (PHP Framework)
1. [Postgresql 13](https://www.postgresql.org/docs/13/index.html "Documentation") (Database)
1. [Docker](https://docs.docker.com/) (Local development environment)
## Tools
### Neccessary
1. [Docker](https://docs.docker.com/) - to run local environment
### Optional
1. [Firefox Developer Edition](https://www.mozilla.org/pl/firefox/developer/)
2. [VS Code](https://code.visualstudio.com/) - [IDE](https://en.wikipedia.org/wiki/Integrated_development_environment)
- Plugins for PHP
- [PHP Debug](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-debug)
- [PHP Intelephense](https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client)
- Plugins for Angular
- [Angular Language Service](https://marketplace.visualstudio.com/items?itemName=Angular.ng-template)
- Plugins for database
- [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)
## How to run app?
1. Download project from repository using standalone git or built in any IDE
2. Install Docker Desktop
3. run command line and go to project directory
4. Go to docker directory
5. Execute `docker compose -p curenet up`
6. Wait until docker building and lauching the app.
At first attempt it can take a few minutes
## Application links
1. Main app: `http://localhost:7700`
2. PgAdmin4 `http://localhost:7700/pgadmin4`
3. PHP Xdebug for fpm: `localhost:7780`
3. PHP Xdebug for cli: `localhost:7781`
## Credentials
### PgAdmin4
- Login: `admin@pgadmin.localhost`
- Password: `WeryStronkPaz2`
- Configuration:
1. Click on Server in left panel
2. Go to Create > Server
3. Enter name (you can name it as you want)
4. Go to Connection tab
5. Enter host name: `localhost`
6. Enter username: `postgres`
7. Enter password: `WeryStronkPaz2`
8. Save it
9. Go to Servers > [you name] > Databases > curenet > Schemas > public > Tables
10. You can see all tables
### Database
- Server: `localhost`
- Port: `5432`
- Username
- For application: `curenet`
- For admin: `postgres`
- Database
- For application: `curenet`
- For admin: `postgres`
- Password: `WeryStronkPaz2`