refactor: ♻️ developer experience

[ap0nia]

Features

docker compose

Simple docker-compose setup for getting started.

1. Clone this repository and change into the correct directory.

git clone [email protected]:icssc/peterportal-api-next
cd peterportal-api-next

2. Install dependencies.

pnpm install

3. Start the development services locally (database).

docker compose up -d

4. Start the local development server.

pnpm dev

Project

Closes #150

[gitguardian]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
11027252	Triggered	Generic Password	1c761d0	docker-compose.yml	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secret safely. Learn here the best practices.
3. Revoke and rotate this secret.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[ap0nia]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
🛠 Guidelines to remediate hardcoded secrets
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

This is a false alarm. The POSTGRES_PASSWORD variable in the docker-compose.yml file is intended only for local development. Production and staging instances will be using AWS RDS credentials.

[ap0nia]

Open issue with prisma and monorepo tech: prisma/prisma#12535

TLDR: they still haven't really optimized the combination.

[ap0nia]

Depending on the program that's used to parse the .env file, it may or may not support variable substitution. TIL, prisma does in fact support it, which is convenient for integrating this with docker-compose. The logic being that docker-compose.yml will automatically parse the nearest .env file (also with variable substitution enabled), and thus share the identical database configuration.

[ap0nia]

Special case.

[ap0nia]

38 MB doesn't seem too bad? 👀
It's extremely simple to setup the local db instance with this format!

[ap0nia]

So the root package.json can run pnpm db:push.