Hackulus'25 Backend Application

Report Bug · Live Deployment

Table of Contents

• Table of Contents
• About The Project
• Built With
• Getting Started
• Prerequisites
• Installation
• Running the Project Locally
• Available Scripts
• Contributors
• License

About The Project

This repository contains the official backend for Hackulus'25, SIAM-VIT’s flagship hackathon.
The backend provides APIs to manage hackathon tracks, panels, admins, submissions, and related workflows.

Key Features:

• RESTful API built with Node.js and Express.js
• PostgreSQL as the primary database
• JWT-based authentication for admins
• Secure validation and error handling
• Deployed and hosted on Render

Built With

This project is built using the following technologies and frameworks:

• Node.js (JavaScript runtime environment)
• Express.js (Fast, unopinionated, minimalist web framework for Node.js)
• PostgreSQL (Open-source relational database)
• JWT (JSON Web Tokens for authentication)
• Render (Platform for deployment)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have the following installed:

• Node.js (v18+ recommended)
• npm (comes with Node.js)
• PostgreSQL

Installation

1. Clone the repo

   git clone https://github.com/SIAM-VIT/hackulus25-be-express.git
   

2. Navigate into the project directory

   cd hackulus25-be-express
   

3. Install dependencies

   npm install
   

4. Set up your environment variables by creating a .env file in the root directory. Example:

   PORT=4000
   DATABASE_URL=postgresql://<username>:<pwd>@localhost:5432/<dbname>
   JWT_SECRET=
   JWT_EXPIRES_IN=15m
   UPLOAD_DIR=uploads
   BCRYPT_SALT_ROUNDS=10
   SENTRY_DSN=
   SENTRY_AUTH_TOKEN=
   REDIS_URL=
   
   # Render DB
   DB_HOSTNAME=
   DB_PORT=
   DB_DATABASE=
   DB_USERNAME=
   DB_PASSWORD=

Running the Project Locally

npm start

The server will start on http://localhost:4000

Available Scripts

In the project directory, run:

npm start

Runs the app in production mode.

npm run dev

Runs the app in development mode using nodemon. The server restarts automatically when code changes are detected.

npm run lint

Checks for lint issues.

Contributors

Aryan Deshpande (Backend)

Aaryan Shrivastav (Backend)

Rishab Nagwani (Full Stack)

License

Distributed under the MIT License. See LICENSE for more information.

Made with ❤️ by SIAM-VIT.