Hack-API

Hack-Api is an API which provides data and details about most of the technical events including Hackathons , GDG-Events , AWS- Events , Microsoft Azure Events , iOS events , Student Developer Details.

Tech Stacks Used

• FastAPI
• MongoDB
• Jinja 2.0
• JWT
• RS256
• DockerFile

Installation

1. Using Docker (Must have Docker Desktop installed and it must be running )

docker pull achiverram28/hack-api-image:latest
docker run -d --name <yourcontainername> -p 80:80 achiverram28/hack-api-image:latest

2. Using Git Clone

// Install your virtual environment and switch it on 

// Cloning the Repository
git clone https://github.com/achiverram28/Hack-API.git

// Installing the dependencies
pip3 install -r requirements.txt

//Running the server
uvicorn app.main:app --reload

Swagger UI Docs

Swagger UI => http:localhost/docs

Redocs => http:localhost/redoc

Naming Guidelines

• When you want to enter the month name in the url , enter the first three letters of the month name with first letter being captial and the rest being in lower case : Ex January => Jan . ** Only in Open Source events use full name of month :Ex January => January. **

• For type of event in mlh you will have to use => a) online b) in_person c) hybrid

• For name , if you have spaces in the event name, cover it up with _ . Example : Google Summer of Code => Google_Summer_of_Code

Guidelines and Usage

• Before using the API , you will have to register for the first time . That has to be done using the http:127.0.0.1/docs , here go to /api/auth/register and click on Try It and then Execute

• From the next time , you will have to login before you will start using it . That has to be done using the http:127.0.0.1/docs , here go to /api/auth/login and click on Try It and then Execute.

• If you want to logout , then you will have to go to http:127.0.0.1/docs and /api/auth/logout and click on Try It and then Execute.

Usage Modes

• Normal Web Version => Data in formatted web page

• Api Developer Version => Data in json format , where the developers can use the json format for indexing and using the data . If you add .json at the end of the url , you will be able to see this.

Features

• Hackathons => { MLH, DEVFOLIO , OPEN SOURCE , COMPETITIVE CODING }

• GDG EVENTS

• AWS EVENTS

• MICROSOFT AZURE EVENTS

• STUDENT DEVELOPER SUPPORT DETAILS

Developer

Ram Samarth B B => [email protected]