Events-Board

A noticeboard that lists upcoming and previous society events.
Website · Request Feature / Report Bug

Table of Contents

• About The Project
  • Supports
• Getting Started
  • Installation
  • Development
• Usage
• Contact
  • Maintainer(s)
  • Creators(s)
• Additional documentation

About The Project

Detailed explaination of the project goes here

(back to top)

Getting Started

To set up a local instance of the application, follow the steps below.

Installation

1. Clone the repository

   git clone https://github.com/metakgp/events-board.git
   cd events-board

2. Install Frontend Dependencies

   cd frontend
   npm install

3. Install Backend Dependencies

   cd backend
   npm install

4. Setup environment variables in the Frontend and Backend directories

   Create a .env file inside /frontend and /backend directory, And set up your environment variables. (See Environment Variables section below for more details)

5. Set up the database

   • In the /backend directory, run the following command to run MongoDB in a Docker container:

     docker compose -f docker-compose.dev.yaml up -d

     Alternatively, you can run MongoDB locally if you have it installed.

6. Set up static file storage

   • Create a directory for static files (ideally outside the project directory), and set the absolute path to this directory in the STATIC_FILE_STORAGE_LOCATION environment variable in /backend/.env (e.g. /srv/static).
   • Create a subdirectory for storing uploaded posters inside the static file storage directory, and set the relative path to this directory in the UPLOAD_PATH environment variable in /backend/.env (e.g. uploads/posters).

Development

• In the /frontend directory, run the following command to start the frontend:

  npm run dev

• In the /backend directory, run the following command to start the backend:

  node index.js

Environment Variables

The following environment variables are required to be set in /backend/.env for the application to run:

1. MONGO_URI: The MongoDB connection string.
2. JWT_SECRET: A secret key used for signing JSON Web Tokens.
3. FRONTEND_URL: The URL of the frontend application.
4. PORT: The port on which the backend server will run.
5. STATIC_FILES_URL: The URL where static files are served.
6. STATIC_FILE_STORAGE_LOCATION: The absolute path where static files are stored.
7. UPLOAD_PATH: The relative path where uploaded files will be stored (relative to STATIC_FILE_STORAGE_LOCATION).
8. ADMIN_MAIL: Email ID for Admin login.
9. ADMIN_PASSWORD: Password for Admin login.

The following environment variables are required to be set in /frontend/.env for the application to run:

1. VITE_BACKEND_URL: The URL of the backend API.

(back to top)

Contact

📫 Metakgp -

Maintainer(s)

The currently active maintainer(s) of this project.

• Waqib Sk
• Dipam Sen

Creator(s)

Honoring the original creator(s) and ideator(s) of this project.

• Waqib Sk

(back to top)

Additional documentation

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

(back to top)