https://github.com/raphaeltm/defang-django-demo
https://github.com/raphaeltm/defang-django-demo
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/raphaeltm/defang-django-demo
- Owner: raphaeltm
- Created: 2025-01-23T18:52:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T19:52:50.000Z (4 months ago)
- Last Synced: 2025-03-14T22:43:14.534Z (2 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django & Postgres
[](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-django-postgres-template%26template_owner%3DDefangSamples)
This template is a customer relationship management list project developed using Python Django framework, offering a starting point to help you quickly build your customer management system. We use PostgreSQL as the database. We have prepared all the essential files for deployment. By spending less than 10 minutes setting up the environment, as detailed in the prerequisites, and executing the commands in our step-by-step guide, your website will be ready to go live to the world!
## Prerequisites
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
## Development
To run the application locally, you can use the following command:
```bash
docker compose up --build
```
## Configuration
For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration):
> Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
### `POSTGRES_PASSWORD`
The password for the PostgreSQL database.
```bash
defang config set POSTGRES_PASSWORD
```
### `SECRET_KEY`
The secret key is used to secure the Django application.
```bash
defang config set SECRET_KEY
```
### `ALLOWED_HOSTS`
The allowed hosts for the Django application. (i.e. the domain your app runs on)
```bash
defang config set ALLOWED_HOSTS
```
## Deployment
> [!NOTE]
> Download [Defang CLI](https://github.com/DefangLabs/defang)
### Defang Playground
Deploy your application to the Defang Playground by opening up your terminal and typing:
```bash
defang compose up
```
### BYOC (AWS)
If you want to deploy to your own cloud account, you can use Defang BYOC:
1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
2. Run in a terminal that has access to your AWS environment variables:
```bash
defang --provider=aws compose up
```
---
Title: Django & PostgreSQL
Short Description: A customer relationship management list project developed using the Python Django framework, offering a starting point to help you quickly build your customer management system.
Tags: Django, PostgreSQL, Python, SQL
Languages: python