tsg-iitkgp / noticeboard

Noticeboard for Technology Coordinator(s) to share notices and updates to students and make public announcements.

Technology Noticeboard

Official updates regarding tech facilities of IIT Kharagpur
Report Bug · Request Feature

Table of Contents

• About The Project
• Serving The Static Site
• Creating Notices
  • Syncing With Server
• Contact
  • Present Technology Coordinator(s)
• Additional Documentation

About the project

This noticeboard displays important announcements about IIT Kharagpur's technical facilities and related events. It serves as a central location for the campus community to find up-to-date information on things like network downtime, maintenance schedules, ERP issues, general guidelines related to tech in IIT KGP and more.

(back to top)

Serving the static site

Use any webserver to host the files in this repository. Following are the quite popular ones:

• nginx
• apache
• python http server

Note

We use nginx in the docker container.
Configuration file for nginx: nginx.conf.

1. Update details of Present Technology Coordinator(s).
   • Save pictures in ./assets with roll number as the file name. For example:

     21IM10009.png

   • Update techcoordi.json. It has the following structure

     [
       {
         "id": "21IM10009",
         "name": "Arpit Bhardwaj",
         "email": "[e-mail]",
         "tele": "9761667733",
         "linkedin": "https://linkedin.com/in/proffapt"
       }
     ]

2. Run the docker container

   sudo docker-compose up -d

3. Visit http://localhost:8001/

Note

Alternatively you can run python3 -m http.server 8001 to serve the files instead of docker or nginx

(back to top)

Creating notices

Make sure you have python installed. Once that is verified, follow the steps below:

1. Run the create-notice.py script

   cd scripts/
   python3 create-notice.py

2. Enter the title in the prompt
3. Type or Paste the notice
4. Press Enter to go to the new line
5. Press Ctrl+D to complete the notice

Syncing with server

1. Move to ./scripts/ directory
2. Configure the environment variables.
   • Copy .env.example as .env
   • Fill the following self-explanatory template

     SERVER_USERNAME=pi
     SERVER_IP=192.168.17.69
     SERVER_DIR=/home/pi/noticeboard/notices
     SERVER_PASSWORD=mysecretpassword 
     # Leave SERVER_PASSWORD empty if SSH through SSH keys is configured

3. Run the create-notice.py script with --sync argument

   python3 create-notice.py --sync

4. Follow steps 2-5 of Creating Notices

(back to top)

Contact

📫 Technology Students' Gymkhana -

Present Technology Coordinator(s)

Note

For any ideas, suggestions or queries regarding this project, mail us at [e-mail]

Name	Email	Phone No.
Arpit Bhardwaj	[e-mail]	[phone]
Parth Gupta	[e-mail]	[phone]

(back to top)

Additional Documentation

• License
• Code of Conduct
• Security Policy
• Contribution Guidelines

(back to top)