Skip to content

geetxnshgoyal/kickstart

Repository files navigation

Kickstart

Project Description

Kickstart is a hackathon landing and registration backend project built with Express.js and Firebase Admin. It provides a complete solution for managing hackathon registrations with a clean landing page interface and robust backend infrastructure.

Features

  • Landing Page: Interactive hackathon landing page with event information
  • User Registration: Complete registration system for hackathon participants
  • Firebase Integration: Secure data management using Firebase Admin SDK
  • Admin Panel: Administrative interface for managing registrations
  • RESTful API: Well-structured API endpoints for registration operations
  • Docker Support: Containerized deployment with Docker and Docker Compose

Tech Stack

  • Backend: Node.js, Express.js
  • Database: Firebase Admin SDK
  • Frontend: HTML, CSS, JavaScript
  • Deployment: Docker, Vercel
  • Additional Tools: CORS, body-parser, dotenv

Setup Instructions

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • Firebase project credentials

Installation

  1. Clone the repository:
git clone https://github.com/Mahaveer-jain-18/kickstart.git
cd kickstart
  1. Install dependencies:
npm install
  1. Configure environment variables:

    • Create a .env file in the root directory
    • Add your Firebase credentials and other configuration
  2. Start the server:

npm start

The application will be available at http://localhost:3000 (or your configured port).

Usage

Documentation for usage and API endpoints coming soon.

Deployment

Refer to DEPLOY.md and DEPLOY-VERCEL.md for detailed deployment instructions.

License

This project is open source and available under the MIT License.