Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.79 KB

README-en.md

File metadata and controls

55 lines (31 loc) · 1.79 KB

Django Project Template

Quer ler este README em português? Clique aqui

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 [email protected]: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.

  1. 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.

  1. 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.