https://github.com/ondiekelijah/bookmarks-manager

A bookmark manager API that allows for simple bookmark management. User creation and authentication with access tokens, adding bookmarks, updating, deleting, and viewing existing bookmarks are all features. It also offers bookmark link visit tracking and statistics.
https://github.com/ondiekelijah/bookmarks-manager

alembic fastapi postgresql sqlalchemy

Last synced: 13 days ago
JSON representation

A bookmark manager API that allows for simple bookmark management. User creation and authentication with access tokens, adding bookmarks, updating, deleting, and viewing existing bookmarks are all features. It also offers bookmark link visit tracking and statistics.

• Host: GitHub
• URL: https://github.com/ondiekelijah/bookmarks-manager
• Owner: ondiekelijah
• Created: 2022-02-02T20:47:06.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-06T08:02:38.000Z (about 3 years ago)
• Last Synced: 2025-01-24T06:09:57.672Z (13 days ago)
• Topics: alembic, fastapi, postgresql, sqlalchemy
• Language: Python
• Homepage: https://develiebookmarks-api.herokuapp.com/
• Size: 58.6 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BookmarksAPI

A bookmark manager API that allows for simple bookmark management. User creation and authentication with access tokens, adding bookmarks, updating, deleting, and viewing existing bookmarks are all features. It also offers bookmark link visit tracking and statistics.

[![Build and Test](https://github.com/Dev-Elie/BookmarksAPI/actions/workflows/build-deploy.yml/badge.svg)](https://github.com/Dev-Elie/BookmarksAPI/actions/workflows/build-deploy.yml)

Read the docs [here](https://develiebookmarks-api.herokuapp.com/docs)

# Installation

1. Navigate into your desired folder, then clone this repo as shown, remember the dot (.) so as to avoid duplicating this repo's name again.

`git clone https://github.com/Dev-Elie/BookmarksAPI.git .`

2. Change to that specific directory

`cd directory path`

3. Create a virtual environment & activate it

**Windows**

          

```bash

#create a venv

py -3 -m venv venv

# activate venv

venv\Scripts\activate

```

          

**macOS/Linux**

          

```bash

#create a venv

python3 -m venv venv

# activate venv

source venv/bin/activate

```

4. Install the requirements from the requirements.txt file.

`pip install -r requirements.txt`

5. Create a `.env` file in the root of the directory then add the following contents, adding values for each depending on your configs.

```

DATABASE_HOSTNAME=

DATABASE_PORT=

DATABASE_PASSWORD=

DATABASE_NAME=

DATABASE_USERNAME=

SECRET_KEY=

ALGORITHM=HS256

ACCESS_TOKEN_EXPIRE_MINUTES=

```

6. Run a database migration

` alembic upgrade head`

7. Start the server

`uvicorn app.main:app --reload`