saqibur / django-project-structure

This is a template/project structure for developing django-based applications - either strictly through the django-rest-framework or just django.

Hi there 👋, I'm Saqibur Rahman, a software engineer from Dhaka, Bangladesh

As a senior software engineer with 4+ years in the software development industry, specializing in backend technologies, I've developed a diverse skill set, encompassing roles such as a technical project manager and a technical lead, where I excel in orchestrating cross-functional teams to deliver high-quality software solutions.

Over the course of my career, I have successfully managed and launched 10+ impactful projects across education, medical, and travel industries - 3 of which harness LLMs to power generative AI solutions for an enhanced customer experience.

Beyond my coding capabilities, I excel in communication, making the intricate details of software development accessible to both technical and non-technical stakeholders across the board.

One of the highlights of my professional journey has been the opportunity to collaborate with engineers across the globe including Sweden, Switzerland, Japan, Thailand, USA and of course Bangladesh!

Alongside my technical roles, I've been fortunate to take on the role of a mentor. Over the course of my journey, I've had the privilege of guiding and nurturing the growth of more than 20 engineers.

Socials

Gists

django-project-structure's Issues

Add a folder for utilities and helpers that are shared across all apps within a project

CRUD queries for each app

Your project structure appears to be well-organized and promising, and I appreciate the effort put into it. I have a question regarding managing database queries efficiently across the application. We often need to write multiple queries and wish to centralize them for reuse within the app or even in other apps in the project

My suggestion is to create a crud folder within the app directory and organize files based on the tables used in the application. Within each file, you can define a class like PostCRUD:

Class PostCRUD:
def get()

 def create()

This approach allows for a systematic organization of database operations, ensuring that queries are centralized and can be easily reused throughout the application or in other projects. It promotes modularity and maintainability, enabling efficient development and scalability.

please suggest any other better approach if you have

Reorganise project into more specific folders

There should be a default DATABASE section in settings. file which is missing now.

There is no DATABASE section in settings.py right now. Which was little bit confusing for me because after configuring database I saw there is no option for entering the DB credentials..

Specify what consitutes as 'version 2' of an API

There may be conflicting points and opinions about what constitutes as an v2 of an API. Therefore, we should create a set of specifications that can help make such a decision and present clear guidelines when versioning.

Update app names to correspond to the type of apps

Add instructions for handling third party code

While just cloned the repo and tried to run showed this error.

Move common files from core app to common app

Moving the common files such as models.py(common BaseModel), helpers.py, constants.py file from the core app to the common app.

Adding different folder(tests) for full-flow testing.

While just cloned the repo and tried to run showed this error. ModuleNotFoundError: No module named 'core'

After cloning the repo and tried to run it, it showed the following error

ModuleNotFoundError: No module named 'core'