HypeLinks API

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

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

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
• FastAPI
• TensorFlow 2

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

   git clone https://github.com/iamyajat/hypelinks-api.git

2. Install virtualenv

   pip install virtualenv

3. Create a virtual environment

   python -m venv env

   .\env\Scripts\activate

4. Install all requirements

   pip install -r requirements.txt

5. Start the API

   uvicorn main:app --reload

Usage

To try the API out, go to http://127.0.0.1:8000/docs/ and test the different end-points out.

Roadmap

See the open 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.
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