Readme.md

How to setup the project

1. Clone the repository git clone https://github.com/AlexiusTatius/College_File_System.git . command.

2. In the backend, if there is no TeacherFolders then create one.

3. In the backend create a .env file and add the values for the following:

   • MONGO_URL
   • FRONTEND_URL: URL of the frontend.
   • EMAIL_USER: The email address of the account that will send the email, in case of the forgot password
   • EMAIL_APP_PASSWORD: The password of the account that will send the email, in case of the forgot password. Check out any video of node-mailer to know how to set up the app password
   • PORT
   • JWT_SECRET

4. Create 2 terminals in vsCode.

5. Navigate the project:

   • In the first terminal navigate to the server folder cd backend.
     • Run npm install to install the dependencies.
     • Run npm run dev to start the server.
   • In the second terminal navigate to the client folder cd frontend.
     • Run npm install to install the dependencies.
     • Run npm run dev to start the client.

6. To avoid any CORS policy issues, you can download and use the browser extension: Allow CORS: Access-Control-Allow-Origin.

7. In Frontend: Configure the postcss.config.js with the following:

   import tailwindcss from 'tailwindcss'
   import autoprefixer from 'autoprefixer'
   
   export default {
   plugins: {
       tailwindcss: {},
       autoprefixer: {},
   },
   }

   Similary configure tailwind.config.js with the following:

   /** @type {import('tailwindcss').Config} */
   export default {
   content: [
       "./index.html",
       "./src/**/*.{js,ts,jsx,tsx}",
   ],
   theme: {
       extend: {},
   },
   plugins: [],
   }

8. In Backend: Run the following scripts to load the department and faculty_data.csv into the MongoDB database:

   Initial Setup:
   1. npm run init-department    (runs once when setting up system to initialize the departments)
   2. npm run init-faculty       (runs once when setting up system to initialize the faculty data)
   
   Later Updates:
   1. Update faculty_data.csv with new entries
   2. npm run update-faculty  (can be run multiple times safely)