nishan212/placement-portal

Placement portal for universities to manage their placement process.

Placement-Portal

We will be using yarn as the package manager for this project.

Branches

develop - main development branch

PLP-X - feature branch where X is the corresponding ticket number

Project Setup

add the environment variables using the .env.example file in both client and server

Go to server:

yarn # to install dependencies
yarn dev # start the server in dev mode

Go to client:

yarn # to install dependencies
yarn codegen #to update type definitions
yarn dev # start the server

Update your feature branch with remote changes [IMPORTANT]

NEVER PULL CHANGES FROM YOUR REMOTE FEATURE BRANCH

git pull origin/PLP-25 #DO NOT DO THIS
        #OR
git pull # when you're in a feature branch locally

DO NOT PUSH TO THE DEVELOP BRANCH

git push # when you are in develop branch locally

COMMANDS TO BE USED

git checkout develop # switching to develop
git pull --rebase # pulling changes from develop
git checkout <feature_branch> # git checkout PLP-24
git rebase develop
## make your changes
git push --force # always do a force push after rebase

Generating types in server

If server is already running in dev mode, save the codegen.yml file to regenerate types.

Alternatively, you can run yarn codegen to generate types

Debugging

To kill the port if EADDRINUSE error:

lsof -i TCP:PORT_NUMBER
kill PID

Checking the DB:

npx prisma studio

Generate prisma client

npx prisma generate

Migrate DB changes:

npx prisma migrate dev

For more info visit package.json in server & client.