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.
Read the docs here
- 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 .
- Change to that specific directory
cd directory path
- Create a virtual environment & activate it
Windows
#create a venv
py -3 -m venv venv
# activate venv
venv\Scripts\activate
macOS/Linux
#create a venv
python3 -m venv venv
# activate venv
source venv/bin/activate
- Install the requirements from the requirements.txt file.
pip install -r requirements.txt
- Create a
.envfile 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=
- Run a database migration
alembic upgrade head
- Start the server
uvicorn app.main:app --reload