Setup

Backend

0. Change into the backend directory
1. Run npm install
2. If changes are made run npm run build to build with those changes
3. To run the backend locally, execute npm run start

Frontend

0. Change into the frontend directory
1. Run npm install
2. To run the frontend locally, execute npm run dev

Database Setup and Management

Dumping

We assume that you already have the PostgreSQL server set up. On Windows:

0. Make sure PostgreSQL is running
1. Add PostgreSQL/{version}/bin to PATH
2. Add PostgreSQL/{version}/lib to PATH
3. Open Windows PowerShell
4. cd into a directory you want the database to export to
5. Run the command pg_dump -U {username} -E=UTF-8 -d PromptLibrary -f {filename}.txt, replacing {username} and {filename} with your username and filename
6. Type your password for the server

Restoring a dump

To load the database from a dump on Windows

0. Delete your current database if you have one
1. Remake a new one with the name PromptLibrary
2. Open Windows PowerShell
3. cd into the directory with the db dump
4. Run the command "cat dump.txt | psql PromptLibrary postgres"

Deploying/Serving with Docker

How to deploy

The project has 3 docker-compose files within the PromptLibrary, Frontend, and Backend directories which can be used to deploy the PropmtLibrary. In order to run the entire PromptLibrary, a user should run this command while in the PromptLibrary directory: docker compose up -d --build

If the user desires, the same command can be ran within the Frontend or Backend directory in order to build only the frontend or backend respectively.

First Build

On the first build of the docker container, the user will also need to run the following:

1. docker exec -it web npx prisma db push
2. docker exec -it web npx prisma db seed This must be done in order to sync the PostgreSQL database with the Prisma file while also seeding the database.

Important Information

Once deployed, the front end will be visible on localhost:8000 while the backend can be directly accessed within localhost:8080. These ports are determined within the docker-compose.yml files and can be modified if required by the user.