https://github.com/luderibeiro/django_base

Base template to start Django project with clean architecture.
https://github.com/luderibeiro/django_base

api api-gateway api-versioning clean-architecture django django-framework django-framework-example django-project django-rest-framework django5-template jazzmin oauth-provider oauth2-authentication python3 rest-framework

Last synced: 3 months ago
JSON representation

Base template to start Django project with clean architecture.

• Host: GitHub
• URL: https://github.com/luderibeiro/django_base
• Owner: luderibeiro
• License: mit
• Created: 2024-04-11T01:00:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-14T18:09:32.000Z (10 months ago)
• Last Synced: 2025-03-31T14:57:50.537Z (7 months ago)
• Topics: api, api-gateway, api-versioning, clean-architecture, django, django-framework, django-framework-example, django-project, django-rest-framework, django5-template, jazzmin, oauth-provider, oauth2-authentication, python3, rest-framework
• Language: Python
• Homepage:
• Size: 441 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-en.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Django Project Template

Quer ler este README em português? [Clique aqui](README.md)

This repository serves as a template for starting projects in Python (version 3.12) with the Django framework (version 5.0).

## About the Project

This Django project is Dockerized and follows the principles of Clean Architecture. It provides a solid structure for developing a variety of applications, from APIs to web applications.

## How to Use

Follow these steps to run the project:

1.  **Clone the Repository:**

        git clone git@github.com:luderibeiro/django_base.git

2.  **Set Up the Environment:**

-   Create a `.env` file in the project root and add necessary configurations such as API keys, database settings, etc.

3.  **Run Docker Compose:**

        docker-compose up --build

`Note: The `--build` flag should be executed only the first time the project is installed or when there are changes in the build files.`

4. **Access the Application:**

   The application will be available at `http://localhost:8000`.

   

   If you want to access the admin page, simply go to `http://localhost:8000/admin/`.

**Error Handling**

-   In case you encounter this error: PermissionError: [Errno 13] Permission denied: '/data/web/static/admin'

    Run the following command:

        sudo chown -R user:group data

`Note: Replace "user" with your local machine username and "group" with the user's group.`

## Contribution

Feel free to contribute improvements or new features. Just follow these steps:

1. Fork the repository.

2. Create a branch for your contribution: `git checkout -b feature/new-feature`.

3. Make your changes and commit: `git commit -m 'Add new feature'`.

4. Push to the branch: `git push origin feature/new-feature`.

5. Open a pull request.

## License

This project is licensed under the [MIT License](LICENSE).