Rawkush/college-website-2

This is a web app of our college.

CBPGEC Website

This is the website of the Ch. Bramh Prakash Govt. Engineering College 🏫.

💥 💥 Visit the site Here. 💥 💥

More Data Will be added as things get built.

Contributions are welcome 🙏. To contribute -

Run the following command opening terminal in the directory root directory of this project.

npm install

Then -

• to start server npm start
• to start server in watch-mode npm run server-watch
• to build app npm run build:prod or npm run build:dev
• to serve app in watch mode npm run dev-server
• to run server test npm run server-test
• to run server tests in watch mode npm run server-test-watch
• to run client tests client-test
• to run client tests in watch mode client-test-watch
• to run all tests npm test
• to run all tests in watch mode npm run test-watch

Follow the code style by using these tools -

1. ESLint
2. Prettier

To setup, you only have to do few this because every package and configuration is included in repository.

Set Up -

1. Download plugin for your code editor.

   • Download ES lint for Visual Studio Code.
   • Download Prettier for Visual Studio code. (optional).

2. Change some settings to these.(I will teach only for VSCode. You have to go in settings and search for the following things.) -

   "prettier.singleQuote": true,
   "editor.formatOnSave": true,
   "[javascript]": { "editor.formatOnSave": false },
   "javascript.format.enable": false,
   "prettier.eslintIntegration": true,
   "eslint.autoFixOnSave": true ,
   "eslint.alwaysShowStatus": true,

If you run into any problem while setting up or in the function of the app, open the issue in this repository. We will try to get back to issue ASAP.

Set up the environment variables -

You need to set up the environment variables for the OAuth and Mongo DB to work.

1. Create a file in root directory and name it .env .

   • Which should look like this.

     DATABASE=yourdatabaselink
     GITHUB_CLIENT_ID=githubclientid
     GITHUB_CLIENT_SECRET=githubclientsecret
     GOOGLE_CLIENT_ID=googleclientid
     GOOGLE_CLIENT_SECRET=googleclientsecret
     LINKEDIN_CLIENT_ID=linkedinclientid
     LINKEDIN_CLIENT_SECRET=linkedinclientsecret
     JWT_SECRET=jwtsecret
     JWT_SECRET_2=anotherjwtsecret

2. Make another file in root directory and name it .env.test . And and put the same variables and make it test related.