https://github.com/iamyajat/hypelinks-api
A Smart Bookmark API that can classify websites into 10 different categories built using FastAPI and Tensorflow 2.0
https://github.com/iamyajat/hypelinks-api
fastapi machine-learning nlp python tensorflow
Last synced: about 1 year ago
JSON representation
A Smart Bookmark API that can classify websites into 10 different categories built using FastAPI and Tensorflow 2.0
- Host: GitHub
- URL: https://github.com/iamyajat/hypelinks-api
- Owner: iamyajat
- License: mit
- Created: 2021-04-13T11:39:50.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-28T22:29:26.000Z (almost 4 years ago)
- Last Synced: 2025-04-15T00:16:52.353Z (about 1 year ago)
- Topics: fastapi, machine-learning, nlp, python, tensorflow
- Language: HTML
- Homepage: https://hypelinks-api.iamyajat.com/
- Size: 95.8 MB
- Stars: 25
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# HypeLinks API
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
HYPELINKS API
A Smart Bookmark API that can classify websites into 10 different categories
Explore the docs »
Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
An API that can classify a given url into various different categories.
#### Categories
- Sports
- News
- Fitness & Wellbeing
- Food & Recipes
- Politics
- Entertainment
- Business
- Blogs
- Science & Technology
- NSFW
### Built With
* [Python 3.8.10](https://www.python.org/downloads/release/python-3810/)
* [FastAPI](https://fastapi.tiangolo.com/)
* [TensorFlow 2](https://www.tensorflow.org/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- Python 3.8.10 and the latest version of pip.
### Installation
1. Clone the repo
```sh
git clone https://github.com/iamyajat/hypelinks-api.git
```
2. Install `virtualenv`
```sh
pip install virtualenv
```
3. Create a virtual environment
```sh
python -m venv env
```
```sh
.\env\Scripts\activate
```
4. Install all requirements
```sh
pip install -r requirements.txt
```
5. Start the API
```sh
uvicorn main:app --reload
```
## Usage
To try the API out, go to [http://127.0.0.1:8000/docs/](http://127.0.0.1:8000/docs/) and test the different end-points out.
## Roadmap
See the [open issues](https://github.com/iamyajat/hypelinks-api/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'feat: AmazingFeature'`)
- Please refer to the commit guidelines mentioned [here](https://www.conventionalcommits.org/en/v1.0.0/).
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Project Link: [https://github.com/iamyajat/hypelinks-api](https://github.com/iamyajat/hypelinks-api)
[contributors-shield]: https://img.shields.io/github/contributors/iamyajat/hypelinks-API.svg?style=for-the-badge
[contributors-url]: https://github.com/iamyajat/hypelinks-api/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/iamyajat/hypelinks-API.svg?style=for-the-badge
[forks-url]: https://github.com/iamyajat/hypelinks-api/network/members
[stars-shield]: https://img.shields.io/github/stars/iamyajat/hypelinks-API.svg?style=for-the-badge
[stars-url]: https://github.com/iamyajat/hypelinks-api/stargazers
[issues-shield]: https://img.shields.io/github/issues/iamyajat/hypelinks-API.svg?style=for-the-badge
[issues-url]: https://github.com/iamyajat/hypelinks-api/issues
[license-shield]: https://img.shields.io/github/license/iamyajat/hypelinks-API.svg?style=for-the-badge
[license-url]: https://github.com/iamyajat/hypelinks-API/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/iamyajat