https://github.com/reubenjohn/task-companion-ai
https://github.com/reubenjohn/task-companion-ai
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/reubenjohn/task-companion-ai
- Owner: reubenjohn
- License: mit
- Created: 2024-03-17T19:27:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T04:59:51.000Z (about 1 year ago)
- Last Synced: 2025-01-21T08:09:33.570Z (4 months ago)
- Language: Python
- Homepage: https://task-companion-ai.vercel.app
- Size: 566 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sample Django Project for Back4app Containers
This repository contains a sample Django application designed to be deployed on Back4app Containers. It serves as a template and guide to help you get started with deploying your own Django applications on Back4app Containers.
## Project Structure
```
├── Dockerfile # Dockerfile for building the Docker image
├── manage.py # Django's command-line utility for administrative tasks
├── myapp # Your Django application
│ ├── __init__.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
├── templates # HTML templates
│ └── home.html
└── requirements.txt # Python dependencies for the Django application
```
## Getting Started
1. Clone this repository to your local machine.
```bash
git clone https://github.com/templates-back4app/containers-python-django.git
cd containers-python-django
```
2. Launch the devcontainer located at `.devcontainer/devcontainer.json`
3. Install the required dependencies using poetry.
```bash
# If you're using VS Code, configure poetry to create the virtual environment inside the project in .venv folder
# This makes it easier for VS Code to discover the interpreter for debugging the app
poetry config virtualenvs.in-project true
poetry install
```
3. Run the Django application locally.
```bash
poetry run manage runserver
```
Alternatively, just hit F5 if you're using VS Code to launch the server in debug mode.
Your Django application should now be running locally at http://127.0.0.1:8000/.
## Deploying to Back4app Containers
First ensure that the requirements.txt file is up-to-date in case you've updated any dependencies:
```bash
poetry export -f requirements.txt --output requirements.txt
```
Follow the step-by-step guide in the article "Run a Django Container App"(https://www.back4app.com/docs-containers/run-a-django-container-app) to deploy this sample Django application on Back4app Containers.
## Customizing the Template
Feel free to customize this template by modifying the `myapp` directory and adding your own routes, views, and functionality. Make sure to update the requirements.txt file with any additional dependencies your application requires.
## License
This sample Django project is released under the MIT License.