University Notes Project

The University Notes Project is a web application designed to streamline the management, sharing, and accessibility of academic notes within a university or educational institution. It offers a centralized platform where students and faculty can upload, organize, and access course-related materials, fostering collaborative learning and resource sharing.

test logins:

username: classrep password: Testing001

Installation

To use the University Notes Project locally, follow these steps:

• Clone the repository:

git clone https://github.com/wathika-eng/uninotes_refactor --depth 1 && cd uninotes_refactor

• Create a virtual environment (optional but recommended):

python -m venv .venv

• Activate the virtual environment:

  • On Windows:

  .venv\Scripts\activate

  • On macOS/Linux:

  source .venv/bin/activate

• Install the required dependencies:

prefer to use uv: curl -LsSf https://astral.sh/uv/install.sh | sh

pip install -r requirements.txt

• Set up the database:

python manage.py migrate

• Create a superuser (optional):

python manage.py createsuperuser

• Run the development server:

python manage.py runserver

Open the website locaaly: http://localhost:8000

known bugs: https://stackoverflow.com/questions/5420789/how-to-install-psycopg2-with-pip-on-python/13158616