claudinoac / nutapp

TBD

NutApp

A Template for production-ready django-based applications

Featuring:

• Django 4+
• Quasar 2+ w/ Vite
• Container runtime

Table of Contents:

• Installation
• Project Architecture
• Contributing
• Team
• FAQ
• Support
• License

---

Installation:

Requisites:

• Install docker and docker-compose

Clone:

• Clone this repository:
  • git clone [email protected]:claudinoac/nutapp

Setup:

• Build and run containers:

  • $ docker-compose up -d

• Access http://localhost:7200

• The ui and the server will be up and listening for file changes.

---

Architecture:

Package Diagram

---

Testing:

Unit tests:

• The unit tests are based on Django test suite

• All the unit tests should be located in apps/app_name/tests/unit/

• To run the unit tests, run

  • $ make run-unit-tests

Contributing

To get started...

Step 1

• Option 1

  • 🍴 Fork this repo!

• Option 2

  • 👯 Clone this repo to your local machine using https://github.com/claudinoac/nutapp.git

Step 2

• HACK AWAY! 🔨🔨🔨

Step 3

• 🔃 Create a new pull request using https://github.com/claudinoac/nutapp/compare/.

---

Team

Maintainers:

Alisson Claudino
github.com/claudinoac

Contributors:

---

FAQ

• How can I change my api configs?
  • In the backend/NutApp/settings/(development|production).py

---

Support

Reach us out at one of the following places!

• Twitter at @_claudinoac

---

License

• GNU GPLv3