{"id":25220511,"url":"https://github.com/palwisha-18/django-drf-template","last_synced_at":"2025-10-25T18:31:42.783Z","repository":{"id":172107994,"uuid":"648481865","full_name":"Palwisha-18/django-drf-template","owner":"Palwisha-18","description":"Template for Django (DRF) Project","archived":false,"fork":false,"pushed_at":"2024-12-17T16:36:15.000Z","size":13,"stargazers_count":12,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-17T17:36:08.417Z","etag":null,"topics":["django-rest-framework","docker","docker-compose","template-project"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Palwisha-18.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-02T04:33:57.000Z","updated_at":"2024-12-17T16:36:19.000Z","dependencies_parsed_at":"2023-07-05T18:31:13.299Z","dependency_job_id":null,"html_url":"https://github.com/Palwisha-18/django-drf-template","commit_stats":null,"previous_names":["palwisha-18/django-drf-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Palwisha-18%2Fdjango-drf-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Palwisha-18%2Fdjango-drf-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Palwisha-18%2Fdjango-drf-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Palwisha-18%2Fdjango-drf-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Palwisha-18","download_url":"https://codeload.github.com/Palwisha-18/django-drf-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238195454,"owners_count":19432106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django-rest-framework","docker","docker-compose","template-project"],"created_at":"2025-02-10T21:53:55.475Z","updated_at":"2025-10-25T18:31:37.492Z","avatar_url":"https://github.com/Palwisha-18.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Django (DRF) Dockerized Project Template\n\nThis repository serves as a template for creating a Django REST Framework (DRF) project that is containerized using Docker. It provides a structured starting point for developing Django-based web applications with a RESTful API, allowing for easier setup and deployment.\n\n## Features\n\n- Django 3.x and Django REST Framework (DRF) pre-configured\n- PostgreSQL database integration\n- Docker and Docker Compose configuration for containerization\n- Separation of development and production settings\n- Automatic database setup and migrations using Django's `manage.py` commands\n- Ready-to-use Django project structure following best practices\n- Simple API endpoint for testing purposes\n- Customizable and extensible to fit your project's needs\n\n## Prerequisites\n\nBefore using this template, ensure that you have the following dependencies installed on your system:\n\n- Docker: [Install Docker](https://www.docker.com/get-started)\n- Docker Compose: [Install Docker Compose](https://docs.docker.com/compose/install/)\n\n## Getting Started\n\nTo start a new project using this template, follow these steps:\n\n1. Clone this repository to your local machine:\n\n```bash\ngit clone https://github.com/Palwisha-18/django-drf-template.git\n```\n\n2. Navigate into the `django_project` directory:\n\n```bash\ncd django-drf-template\ncd django_project\n```\n\n3. Set environment variables:\n\n```bash\ncp .env.sample .env\n```\n\nOpen the `.env` file and set the value of all environment variables.\n\n4. Build and run the Docker containers:\n\n```bash\ndocker-compose up -d --build\n```\n\nThis command will download the required Docker images, set up the containers, and start the development server.\n\n5. Access the Django application:\n\nYou can access the Django application running on `127.0.0.1:8000` in your web browser.\n\n6. Test the API endpoint:\n\nA sample API endpoint is available at `127.0.0.1:8000/api/app1/home`. You can modify or extend it according to your project's requirements.\n\n## Using this template\n- Rename `django_project` folder according to the name of your django project and replace its usage in the project.\n- Rename `app1` to represent the application name in your django project. Similarly, replace its usage in the project.\n- You can add more apps under api directory. For each app added, add app name to `INSTALLED_APPS` in `config/settings/base.py` and add app urls to `api/urls.py`\n\n## Configuration\n\n- **Django Settings**: The project-specific Django settings are located in the `config/settings/` directory. You can modify these files to adjust the project's configuration based on your needs.\n\n- **Database**: By default, this template uses PostgreSQL as the database backend. You can update the database settings in the `docker-compose.yml` and `config/settings/base.py`\n\n- **Docker Configuration**: The Docker configuration files (`Dockerfile` and `docker-compose.yml`) are included in the root directory. If you need to make changes to the container setup or add additional services, you can modify these files accordingly.\n\n## Development Workflow\n\n- During development, you can modify the Django code, and the changes will be automatically detected and applied.\n- To stop the development server and the associated containers, use the following command:\n\n```bash\ndocker-compose down\n```\n\n## Deployment\n\nTo deploy the project to a production environment, you can use Docker Compose or any other preferred deployment method. Ensure that you update the necessary configurations for a production environment, such as using a secure secret key, configuring HTTPS, and setting up any required production database or caching services.\n\n## Contributing\n\nIf you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Acknowledgements\n\nThis project template is inspired by the excellent Django and Docker tutorials and best practices available in the Django and Docker communities.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpalwisha-18%2Fdjango-drf-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpalwisha-18%2Fdjango-drf-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpalwisha-18%2Fdjango-drf-template/lists"}