Skip to content

README.md

Latest commit

 

History

History
47 lines (35 loc) · 1.47 KB

README.md

File metadata and controls

47 lines (35 loc) · 1.47 KB

Bookmarker API

The Bookmarker API is a simple RESTful API designed to manage bookmarks. The API allows users to create, read, update, and delete bookmarks, making it a useful tool for personal bookmark management or integration into larger projects that require bookmark functionality.

Features

  • Create: Add new bookmarks with a title, URL, and optional description.
  • Read: Retrieve all bookmarks or a specific bookmark by ID.
  • Update: Modify existing bookmarks.
  • Delete: Remove bookmarks that are no longer needed.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed on your local machine:

Installation

  1. Clone the repository:

    git clone https://github.com/swewalka-tgm/bookmarker-api.git
cd bookmarker-api

  2. Install the required dependencies:

pip install -r requirements.txt
  1. Set up environment variables: Create a .flaskenv file in the root directory (if not already present) and add the following configuration:
FLASK_APP=src
FLASK_ENV=development
  1. Run the application:
flask run

Deployment

To deploy this API on a platform like Heroku, you can use the provided Procfile. Make sure to configure any necessary environment variables on your deployment platform.