https://github.com/ujitkumar1/hackathonapi

HackathonAPI: A Python app for managing hackathons and submissions
https://github.com/ujitkumar1/hackathonapi

flask-restful hackathon-project python restful-api

Last synced: 10 months ago
JSON representation

HackathonAPI: A Python app for managing hackathons and submissions

• Host: GitHub
• URL: https://github.com/ujitkumar1/hackathonapi
• Owner: ujitkumar1
• Created: 2023-03-30T13:47:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-04T05:24:42.000Z (almost 3 years ago)
• Last Synced: 2025-01-25T18:16:10.755Z (12 months ago)
• Topics: flask-restful, hackathon-project, python, restful-api
• Language: Python
• Homepage: https://github.com/ujitkumar1/HackathonAPI
• Size: 435 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
## HackathonAPI: A Python app for managing hackathons and submissions

### Description:

HackathonAPI is a RESTful API that provides endpoints for managing hackathons and submissions. With HackathonAPI, you can create and manage hackathons, track submissions, and award prizes to winners. The API is designed to be easy to use and flexible, allowing you to customize the hackathon rules and submission types to fit your needs. Whether you're hosting a small internal hackathon or a large public competition, HackathonAPI can help streamline the process and make it easier to manage.

### Prerequisites:

1. Python Programming language

2. MySql

3. flask

4. flask_restful

5. json

### Installation:

To install the required packages and libraries, run the following command in your current working directory:

command

```pip install -r requirements.txt```

This command will install all the necessary dependencies listed in the requirements.txt file, allowing you to run the

project without any issues.

### Usage:

To run the application, execute the following command in your current working directory:

Command

```python main.py```

This will start the application, and you should be able to use it. (or) Directly run the main.py file

#### Endpoint Working:

1. **User Registration**(```http://127.0.0.1:5000/register```)

    - Endpoint for creating a new User.

   

      ![img.png](documentaionImage/img.png)

    - 

    - Example:

      Input:

      ```

      Json_data = {

       "username":"ujit1",

       "password":"123"

      }

      ```

      Output:"message": "User created successfully."

2. **Hackathon Registration**(```http://localhost:5000/create-hackathons```)

    - Endpoint for creating a New Hackathon(POST)

    - Example:

      

      Authorization:

   

     ![img_1.png](documentaionImage/img_1.png)

      

      Working:

   

    - ![img_2.png](documentaionImage/img_2.png)

     

3. **Retrieving Hackathons**(```http://localhost:5000/create-hackathons```)

    - Endpoint for Retrieving Hackathon(GET)

    - Example:

      

      Authorization:

   

     ![img_1.png](documentaionImage/img_1.png)

      

      Working:

   

    - ![img_3.png](documentaionImage/img_3.png)

4. **User Registering for Hackathons**(```http://localhost:5000/register-hackathon```)

    - Endpoint for  User Registering for Hackathons

    - Example:

      

      Authorization:

   

     ![img_1.png](documentaionImage/img_1.png)

      

      Working:

   

    - ![img_4.png](documentaionImage/img_4.png)

4. **User Submission for Hackathons**(```http://localhost:5000/submit-hackathon```)

    - Endpoint for User Submission for Hackathons

    - Example:

      

      Authorization:

   

     ![img_1.png](documentaionImage/img_1.png)

      

      Working:

     ![img_5.png](documentaionImage/img_5.png)

5. **User Submissions for all Hackathons**(```http://localhost:5000/my-hackathons/```)

    - Endpoint for retrieving the all Submission of a User

    - Example:

      

      Authorization:

   

     ![img_1.png](documentaionImage/img_1.png)

      

      Working:

      ![img_6.png](documentaionImage/img_6.png)

5. **User Submissions for particular Hackathons**(```http://localhost:5000/my-submissions//```)

    - Endpoint for retrieving the particular Submission of a User

    - Example:

      

      Authorization:

   

     ![img_1.png](documentaionImage/img_1.png)

      

      Working:

      ![img_7.png](documentaionImage/img_7.png)

     

#### In addition to the code and documentation, I have included a Postman request file named "CheckHacathon.postman_collection.json" in the "postmanJson" directory. This file contains a collection of requests that were made using the Postman application, providing a convenient way to test the functionality of the API.

### Contact:

Name : Ujit Kumar

Email : ujitkumar1@gmail.com