https://github.com/teewrath/notexplorer-api
An API that fetches information about upcoming hackathons
https://github.com/teewrath/notexplorer-api
Last synced: about 1 year ago
JSON representation
An API that fetches information about upcoming hackathons
- Host: GitHub
- URL: https://github.com/teewrath/notexplorer-api
- Owner: TeeWrath
- Created: 2023-08-19T13:03:42.000Z (almost 3 years ago)
- Default Branch: hackathon-api
- Last Pushed: 2023-12-27T15:09:02.000Z (over 2 years ago)
- Last Synced: 2025-05-06T21:09:56.586Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 78.9 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NoteXplorer-API
This is an API which scrapes information about upcoming Hackathons and Tech Programs from different websites and enlists them.
It is part of a project called [**NoteX**](https://github.com/The-NoteX/NoteX)
# Tech Stack Used
- Python
- Selenium
- Docker
- Fast API
# Build Instruction
- Clone the repo
```sh
git clone https://github.com/TeeWrath/NoteXplorer-API.git
```
- Move to Repository Directory
```sh
cd NoteXplorer-API
```
- Build Docker Container
```sh
docker build -t main.py .
```
- Use the container and activate the API
```sh
docker run -d -p 8000:80 --name fastapi-container main.py
```
- Use the following endpoint
``` http://10.50.5.86:8000/hackathons```
# Contribution Guidelines
- Clone the repositoy in your local system.
- Go through the application and find issues or features that you wish to add.
- Go to issues and create your issue.
- Wait for issue to be assigned.
- Work on your issue
- Create a pull request
- Wait for it to be reviewed and merged
- Congratulations !! You have just contributed to Hackathon API.