Community
/
CureNet
2
1
Fork 0
Code Issues 1 Pull Requests 1 Projects 1 Releases Wiki Activity
CureNet/src
History
Michał Sieciechowicz d0b3a1be35 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>
 		2021-07-23 18:30:38 +00:00
..
backend Create user model (#10) 2021-07-23 17:26:59 +00:00
frontend Configure docker for local environment (#9) 2021-07-23 16:10:31 +00:00
README.md Update documentation (#11) 2021-07-23 18:30:38 +00:00

README.md

Technical documentation

Frontend

  1. HTML 5
  2. CSS 3
  3. JavaScript
  4. TypeScript
  5. Angular 12 (Frontend framework)

Backend

  1. PHP 8.0
  2. Symfony 5 (PHP Framework)
  3. Postgresql 13 (Database)
  4. Docker (Local development environment)

Tools

Neccessary

  1. Docker - to run local environment

Optional

  1. Firefox Developer Edition
  2. VS Code - IDE

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
  4. 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 > [your 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

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