Django Eye ⚡

Django starter project to build django project quickly with powerful tools.

Installation

Django Eye can be installed via Pip or Pipenv. To start, clone the repository to your local computer.

$ mkdir <your_directory_name>
$ cd <your_directory>
$ git clone https://github.com/alex1the1great/Django-Eye.git .
$ touch .env
$ cp .env.template .env

Development

Pip

$ python -m venv venv_djangoeye
$ source venv_djangoeye/bin/activate
$ pip install -r requirements/development.txt

Pipenv (It will install all packages)

$ pipenv install
$ pipenv shell

Django new secret key

$ python manage.py shell
>>> from django.core.management.utils import get_random_secret_key
>>> get_random_secret_key()
# copy the secret key and assign it to DJANGO_SECRET_KEY

PostgreSQL setup

Create new postgresql database and add credentials into .env file.

Migrate and run Django server

$ python manage.py migrate
$ python manage.py runserver

Empty README.md file

Delete .git directory

$ rm -rf .git

Create a new git repository

$ git init
$ git add .
$ git commit -m "Initial setup"

Configuration

Create a new app

$ cd apps
$ django-admin startapp <your_app_name>

Register a newly created app

• Go to roots/settings/base.py

INSTALLED_APPS = [
    'apps.<your_app_name>.apps.<your_app_name>Config',
]

• Go to apps/<your_app>/apps.py
• Change the app name to:

  name = 'apps.<your_app_name>'

$ cd ..
$ python manage.py runserver

Include Django app url in root.urls file

urlpatterns = [
    path('', include('apps.app_name.urls'))
]

Production ❗

• Add your own domain name in ALLOWED HOSTS list in .env file.
• Change settings file to 'root.settings.production'

🤝 Contributing

Contributions, issues and feature requests are welcome!

⭐️ Support

Give a ⭐️ if this project helped you!