Notepal

This tool provides an easy way for users to interact with and source through their notes.

Installation steps

Prerequisites

• Docker: Install Docker
• Docker Compose: Install Docker Compose

Pull the docker pgvector image:

docker pull ankane/pgvector

Local Setup

Clone the Repository:

Clone the Notepal project repository from the source:

git clone https://github.com/Technology-Innovation-Club/NotePal.git
cd NotePal

Create a virtual environment:

python3 -m venv env

Create a Postgres database in the pgvector docker container

Adding the Postgres database details to your env/bin/activate file:

export TIC_DB_NAME=[your local db name]
export TIC_DB_USER=[your local db user]
export TIC_DB_PASSWORD=[your local db password]
export TIC_DB_HOST=localhost
export TIC_DB_PORT=5433
export DEPLOYMENT_TIER=dev

Install of the requirements

pip install -r requirements.txt

Migrate all the tables:

python manage.py migrate

Run the application:

python manage.py runserver

Running tailwind

Prerequisites

NPM: Nodejs

Local Setup

Go to settings an specify the path npm on your machine or run which npm in your console.

Specify the path in settings.py

NPM_BIN_PATH = <path-to-npm>

Run

python manage.py tailwind start