Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.53 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.53 KB
Raw

CTF-Backend

Backend Repository for IIITV-CTF

For Contributers

Please give a read to this Wiki

Setup📝

Requirements☕

  • Nodejs v14+
  • NPM v6+
  • Git

    • Installation💻

    Firstly, clone the repository from github by running the following command:

    git clone https://github.com/iiitv/CTF-Backend.git

    Enter the working directory by running the following command:

    cd CTF-Backend

    Install the required dependencies by running the following command:

    npm install

    Configuration⚙️

    Create a file named .env in the config folder of the root directory. This file will store the environment variables. Do not commit this file or remove it from gitignore when pushing to github.

    Environment Variables

    Variable Description
    PORT Port number to run the server on
    DATABASE_URL Connection string of the database

    Running the Server⚡

    Run the following command to start the server:

    npm start