Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 2.77 KB

Contribution-guide.md

File metadata and controls

100 lines (65 loc) · 2.77 KB

Welcome contributors, this is the official site of the Training-Placement-Cell. This is the setup-guide for this project.

Backend-setup

  1. Navigate to : backend/config/database.js and apply these changes
connection: {
host: env('DATABASE_HOST', 'localhost'),

port: env.int('DATABASE_PORT', 5432),

database: env('DATABASE_NAME', 'tnp-test'),

user: env('DATABASE_USERNAME', 'postgres'),

password: env('DATABASE_PASSWORD', '2006001'),

schema: env('DATABASE_SCHEMA', 'public'), 

}
  1. Navigate to : backend/config/server.js and apply these changes
host: env('HOST', 'localhost'),
  1. To run backend: 
    cd backend
docker compose up -d
npm run dev || bun dev

Frontend-setup

  1. Navigate to: frontend/config/index.js and apply these changes
export const API_URL =

process.env.NEXT_PUBLIC_API_URL || "http://localhost:1337"

export const NEXT_URL =

process.env.NEXT_PUBLIC_FRONTEND_URL || 'http:localhost:3000'
  1. To run frontend: 
    cd frontend
npm run dev || bun dev

Strapi-setup

  1. Firstly, you have to signup to the strapi,

  2. Navigate to: Settings/Roles: it will look like this

  3. Now for roles and permissions configuration:

  4. Content Manager: photo:

  5. Create some users of different profile (like coordinator, student etc.) under "user" relation.

"document" is not defined (Error)

  • This error may come to you for after running the frontend this is basically due to SSR.
  • To handle this you should apply the dynamic imports in files containing "Lottie" (About.js , Loading.js and WhyUs.js) under frontend/components/LandingPageElements
import dynamic from "next/dynamic";

const Lottie = dynamic(()=>import("lottie-react"),{ssr:false})
  • Never commit these changes this is only to remove the development error, it is not an error at the production

Do's and Don'ts

  • Always remove the console.logs which you have created while developing any feature or fixing bugs.
  • Make sure you don't expose or hardcode the Backend URL in any of your function.
  • Never commit the setup works which you have done inorder to run the project locally.
  • Make a new branch for every new bug fixing or feature.
  • Your local master || main branch should always be updated with the remote's main branch
  • Never make a pull request in the master branch, use test branch for it.
  • Pull request must have a detailed description about its intent, you can check the pull request template in pull_request_template.md.
  • The commits' messages and pull requests titles must be clear about the purpose they serve.
  • Watch the official repository so you will be informed about every actions there.