PediaLink

PediaLink is a child and maternal health care system. This is our 2nd Year Group Project.

Team Members

• Manimehalan
• Udan Sachintha
• Keeththigan
• Chamod Haritha

Requirements

Before setting up the project, make sure you have the following installed:

• Composer
• Docker

Note: Do not install docker desktop. Install docker engine + compose.

Project Setup

1. Clone the Repository

git clone https://github.com/mani-hash/pedialink.git

cd pedialink

2. Set up .env file

cp .env.example .env

Update the .env file with correct entries.

Members of cs 28: Ask in the group for correct entries!

3. Start docker service

sudo systemctl start docker

4. Build the docker container

docker compose up --build

The above command will build and run the application

How to run/stop the app?

1. Run the container

docker compose up

Or if you want to run the container in detached mode:

docker compose up -d

2. Stop the container

docker compose down

Set up app key for token generation for the application

Our application depends on the existence of unique app id for generation of secure tokens and signed URL. By default the config assigns an unsafe value.

Update the .env with random character combination for security. An example is shown below

APP_KEY=232131

Set up the correct url to receive working links in email

The correct app url must be set to get working links in the email. Since this project is being run locally, the correct link is http://localhost:8080

APP_URL=http://localhost:8080

Set up mailtrap for SMTP emails

Create an account in Mailtrap and register a test sandbox for free.

Get the smtp credentials from the dashboard.

Update the .env file with the following entries. Fill in the smtp username and password accordingly.

MAIL_DRIVER=smtp
MAIL_FROM_ADDRESS=no-reply@example.com
MAIL_FROM_NAME=Example
SMTP_HOST="sandbox.smtp.mailtrap.io"
SMTP_PORT=587
SMTP_USER=<YOUR-USERNAME>
SMTP_PASS=<YOUR-PASSWORD>
SMTP_ENCRYPTION=tls

Storage fix for docker

Type the following commands to fix storage issues:

1. Find the id for www-data in the docker container

Type this command inside the project root. This will give you the uid.

docker compose exec app id www-data

NOTE: The value will be typically 33

2. Change the storage folder owner to the above id

This will change the owner of the storage folder. In my case the id was 33.

NOTE: Remember to also give group access to your own user to prevent permission issues

sudo chown -R 33:$USER ./storage

3. Change the permissions for storage folder

Change the permissions for all directories inside storage folder

sudo find ./storage -type d -exec chmod 775 {} \;

Change the permissions for all files inside storage folder

sudo find ./storage -type f -exec chmod 664 {} \;

Additional info:

• By default the project runs under localhost:8080
• By default, you can connect to the database through external services or 3rd party front-end client under the following host: localhost:5432
• Note that the web app container may not be able to access the database through the above host name and port! Use docker's internal network name! This entry is db by default.
• Remember to copy the github hooks in hooks/commit-msg to .git/hooks. Make sure to set appropriate permissions