Django project

Project Demo - Study Buddy App Link

Project Docs - Documentation

Project Kanban - Consider Contributing

Getting Started

• Clone the repo

git clone https://github.com/shtayeb/Django-Studybudy-YT.git

• Create a virtualenv

virtualenv .venv

• Activate the virtualenv

source ./.venv/bin/activate

• Install requirements

# Django packages
make install

# npm packages for tailwindcss
make npm-install

• Create .env file

cp .env.sample .env

• Migrate the database

make migrate
make update

• Create a superuser

make superuser

• Seed database with fake data

make db-seed

• Run the server

make serve

python src/manage.py runserver --setting=core.settings.local # local settings
python src/manage.py runserver --setting=core.settings.production # production settings

• Run the tailwind watch

make t-watch

Docs

class Product(models.Model):
    content_type = models.ForeignKey(
        ContentType,
        on_delete=models.CASCADE,
        limit_choices_to=
            {
                'model__in':('book','cupboard')
            }
    )
    object_id = models.PositiveIntegerField()
    item = GenericForeignKey('content_type','object_id')

Packages to consider

• django-prose
• django-extra-settings
• django-jet-reboot