Skip to content

sauravpanchal/bookmarks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bookmarks

Bookmark REST API build using Flask framework.

Tip : You can clone this repo, run this REST API locally then, import the same through Postman

NOTE : Due to hosting issues, there's internal server error (5xx)


Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

bookmarks

A REST API that let's you manage URLs easily with user link tracking feature.
Explore the docs »

View Demo · Report Bug · Request Feature
Documentation

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Flask framework
  • Status codes (Information/Success/Redirect/Client/Server)
  • Configuring model and database
  • ORM with SQLAlchemy
  • User registration/login with JWT (access + refresh)
  • Configuring URL endpoints and routing
  • Protecting routes with bearer token requirement
  • Pagination
  • Error handling (Custom/Client-side/Server-side)
  • Postman

Installation

  1. Clone the repo
    git clone https://github.com/sauravpanchal/bookmarks.git
    

Usage

  • Screenshots

    Product Name Screen Shot

    Product Name Screen Shot

Roadmap

See the open issues for a list of proposed features (and known issues) & also you can request the same ✨ .

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch - git checkout -b feature/feature_name
  3. Commit your Changes - git commit -m 'Add some feature_name'
  4. Push to the Branch - git push origin feature/feature_name
  5. Open a Pull Request
  6. Wait for your Pull Request to be reviewed

License

Distributed under the MIT License. See LICENSE for more informations.

Contact

Saurav Panchal

Project Link : https://github.com/sauravpanchal/bookmarks

Acknowledgements