https://github.com/app-generator/sample-docker-django-pgsql
Docker Sample - Django & PgSQL | AppSeed
https://github.com/app-generator/sample-docker-django-pgsql
django docker open-source postgresql
Last synced: 2 months ago
JSON representation
Docker Sample - Django & PgSQL | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/sample-docker-django-pgsql
- Owner: app-generator
- License: other
- Created: 2022-11-04T06:11:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-21T07:44:15.000Z (over 3 years ago)
- Last Synced: 2025-10-14T04:19:48.708Z (9 months ago)
- Topics: django, docker, open-source, postgresql
- Language: SCSS
- Homepage: https://appseed.us/product/material-kit/django/
- Size: 6.24 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django & PostgreSQL](https://github.com/app-generator/sample-docker-django-pgsql) `Docker Sample`
`Open-Source` seed project provided by AppSeed in **Django** Framework on top of **[Material Kit](https://appseed.us/product/material-kit/django/)** design. Designed for those who like bold elements and beautiful websites, **Material Kit 2** is ready to help you create stunning websites and web apps. `Material Kit 2` is built with over 60 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
- 👉 [Django Material Kit](https://appseed.us/product/material-kit/django/) - product page
- 👉 [Django Material Kit](https://django-material-kit.appseed-srv1.com/) - LIVE App
## [Black Friday](https://appseed.us/discounts/) - `75%OFF`
> The campaign is active until `30.NOV` and applies to all products and licenses.
[](https://appseed.us/discounts/)
> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-09-18 07:49`
- ✅ `Up-to-date dependencies`
- ✅ `Session-Based authentication`, Forms validation
- ✅ `Docker`: bundled with `PostgreSQL`
- `LIVE-reload` on changes
## ✨ Start in `Docker`
**Note**: Make sure the PORT `5432` is free (usually reserved by the local PostgreSQL instance).
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/sample-docker-django-pgsql.git
$ cd sample-docker-django-pgsql
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
> 👉 **Step 3** - `Migrate DB`
```bash
$ docker-compose run --rm appseed-app python manage.py makemigrations
$ docker-compose run --rm appseed-app python manage.py migrate
```
> 👉 **Step 4** - Create `Superuser`
```bash
$ docker-compose run --rm appseed-app python manage.py createsuperuser
```
> 👉 **Step 5** - Access the `APP`
Visit `http://localhost:5085` in your browser. The app should be up & running.
## ✨ Manual Build
> Download the code
```bash
$ # Get the code
$ git clone https://github.com/app-generator/sample-docker-django-pgsql.git
$ cd sample-docker-django-pgsql
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/`.
### 👉 Set Up for `Windows`
> Install modules via `VENV` (windows)
```
$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt
```
> Set Up Database
```bash
$ python manage.py makemigrations
$ python manage.py migrate
```
> Start the app
```bash
$ python manage.py runserver
```
At this point, the app runs at `http://127.0.0.1:8000/`.
## ✨ Create Users
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
- Start the app via `flask run`
- Access the `registration` page and create a new user:
- `http://127.0.0.1:8000/register/`
- Access the `sign in` page and authenticate
- `http://127.0.0.1:8000/login/`
## ✨ Code-base structure
The project is coded using a simple and intuitive structure presented below:
```bash
< PROJECT ROOT >
|
|-- core/ # Implements app configuration
| |-- settings.py # Defines Global Settings
| |-- wsgi.py # Start the app in production
| |-- urls.py # Define URLs served by all apps/nodes
|
|-- apps/
| |
| |-- home/ # A simple app that serve HTML files
| | |-- views.py # Serve HTML pages for authenticated users
| | |-- urls.py # Define some super simple routes
| |
| |-- authentication/ # Handles auth routes (login and register)
| | |-- urls.py # Define authentication routes
| | |-- views.py # Handles login and registration
| | |-- forms.py # Define auth forms (login and register)
| |
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/ # Templates used to render pages
| |-- includes/ # HTML chunks and components
| | |-- navigation.html # Top menu component
| | |-- footer.html # App Footer
| | |-- scripts.html # Scripts common to all pages
| |
| |-- layouts/ # Master pages
| | |-- base.html # Used by common pages
| |
| |-- accounts/ # Authentication pages
| | |-- login.html # Login page
| | |-- register.html # Register page
| |
| |-- home/ # UI Kit Pages
| |-- index.html # Index page
| |-- page-404.html # 404 page
| |-- *.html # All other pages
|
|-- requirements.txt # Development modules - SQLite storage
|
|-- .env # Inject Configuration via Environment
|-- manage.py # Start the app - Django default start script
|
|-- ************************************************************************
```
---
[Django & PostgreSQL](https://github.com/app-generator/sample-docker-django-pgsql) `Docker Sample` - Open-source starter provided by **[AppSeed Generator](https://appseed.us/generator/)**.