https://github.com/mohamedhany99/simple-note-taker-django-app

https://github.com/mohamedhany99/simple-note-taker-django-app

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mohamedhany99/simple-note-taker-django-app
• Owner: Mohamedhany99
• Created: 2023-11-23T14:04:48.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-23T17:44:10.000Z (about 1 year ago)
• Last Synced: 2023-11-24T15:29:33.596Z (about 1 year ago)
• Language: Python
• Size: 157 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## How to run the application

* clone the application

* create a virtual environment to contain the project (for example: virtualenv venv)

* activate the virtual environment for windows: (source venv/Scripts/activate) for linux: (source venv/bin/activate)

* create .env file 

    * add the SECRET_KEY as a environment variable

    * add the DEBUG=True in case of development stage

* install the requirements (pip install -r requirements.txt)

* create the database

    * python manage.py makemigrations

    * python manage.py migrate

* create the super user (Optional)

    * python manage.py createsuperuser

    * follow the instructions

* run the application

    * python manage.py runserver

# OpenAI Integration

you need to add env variables for the settings related to OpenAI.

* In the SummaryAiView I could not test it due to lake of OpenAI API key

    * OPENAI_API_KEY: openai api key(string)

    * OPENAI_URL: openai URL(string)

    * OPENAI_MODEL_NAME: Model name(string)

    * OPENAI_MAX_TOKENS: Integer

    * OPENAI_STREAM:Boolean

# OpenAI Azure Settings

* The used config is the Azure openai engine

    * OPENAI_AZURE_API_KEY = api key(string)

    * OPENAI_AZURE_URL = URL(string)

    * OPENAI_AZURE_API_BASE_URL = URL(string)

    * OPENAI_AZURE_ENGINE = (string)

    * OPENAI_AZURE_API_VERSION = (string)

    * OPENAI_AZURE_MODEL_NAME = Model name(string)

    * OPENAI_AZURE_MAX_TOKENS = (int)

    * OPENAI_AZURE_STREAM : (bool)

    * OPENAI_AZURE_EMBEDDINGS_ENGINE : (string)

# Notes for navigation

* you can find the home page when accessing: http://localhost:8000/

* you can find the admin dashboard: http://localhost:8000/admin/

* you can find swagger documentation: http://localhost:8000/api/schema/swagger-ui/