Periodum API

Periodum project's backend.

Tech Stack

NodeJS: v16.13.2 (includes npm v8.1.2) with TypeScript
PostgreSQL: v12.1
Latest Docker Engine with Docker-Compose

Development

Run localy

After you have required tech stack above, feel free to run it like this.

npm install && \
npx prisma generate && \
npm run dev

Run inside Docker

# Run the db in background
docker-compose --env-file ./dev.env up -d db

# Run the app in foreground
docker-compose --env-file ./dev.env up app --build

# Run the app in background
docker-compose --env-file ./dev.env up -d app --build

Some tips

--build arg is required when you need to install new package unless you install inside the container.
You can connect to the running container via VSCode without installing NodeJS or any other dependencies on your machine. Just attach to the Periodum API container after running the container.

Running migrations

Please always follow the latest Prisma documentation for migrations.

# It will reset the db,
# apply all migrations
# and run the seed
# Currently it will import only Elements and Isotopes
npx migrate reset

# For help you man checkout the manual
npx prisma migrate --help

Prisma Migration Commands

# Create a migration from changes in Prisma schema,
# apply it to the database,
# trigger generators (e.g. Prisma Client)
prisma migrate dev

# Reset your database and apply all migrations
prisma migrate reset

# Apply pending migrations to the database in production/staging
prisma migrate deploy

# Check the status of migrations in the production/staging database
prisma migrate status

Contribution Guidelines

Please follow the same guidelines with the main project.

TL;DR

Fork the repository
Create a feature or bugfix branch from the develop branch (ex: feature/awesome-feature) on your fork.
Work on your new branch
To avoid working on the same issue; after very first commit, please create a draft pull request to our develop so other contributors will know that you're working on the issue. Other contributors might give you early feedback on your implementation for saving time
When it's ready, change the PR to "Ready to Review"

Contact

Feel free to join our Discord chat. After join Evrim Ağaçı's server, find us on Periodum channels.

evrimagaci / periodum-api

readme