sankalp/DevSuite
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

This commit refactors the project structure by moving the models and API to separate directories. It also updates the settings, Procfile, manage.py, and README files accordingly. The purpose of this change is to improve the organization and maintainability of the project.

Browse Source
This commit is contained in:
sankalp committed 2025-12-09 10:43:31 +05:45
1 parent 4dec888e17
commit e78841631c
116 files changed
+636 -899
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.djinit
+21
View File
@@ -0,0 +1,21 @@
{
"project_name": ".",
"structure": {
"standard": false,
"predefined": false,
"unified": false,
"single": true
},
"apps": {
"nested": false,
"nested_dir": null
},
"settings": {
"use_database_url": true,
"database_type": "mysql"
},
"cicd": {
"github": true,
"gitlab": false
}
}
.env.sample
+2 -4
View File
@@ -1,13 +1,11 @@
# Django settings
DJANGO_SETTINGS_MODULE=config.settings.development
DJANGO_SETTINGS_MODULE=src.settings.development
SECRET_KEY= your-secret-key
ALLOWED_HOSTS=api.your-domain.com,www.your-domain.com
# Database URL (recommended for production)
DATABASE_URL=postgres://user:password@host:port/database_name
DATABASE_URL=mysql://user:password@localhost:3306/src
# Frontend URL
FRONTEND_URL=http://frontend.your-domain.com
# Email settings
EMAIL_HOST=
LICENSE
-201
View File
@@ -1,201 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Procfile
+6 -6
View File
@@ -1,20 +1,20 @@
# Procfile for config
# Procfile for .
# Used for deploying to PaaS platforms like Heroku, Railway, Render, etc.
# Web server process (using Gunicorn)
# Adjust workers based on your needs: (2 x CPU cores) + 1
web: gunicorn config.wsgi:application --bind 0.0.0.0:$PORT --workers 2 --timeout 120 --access-logfile - --error-logfile - --log-level info
web: gunicorn ..wsgi:application --bind 0.0.0.0:$PORT --workers 2 --timeout 120 --access-logfile - --error-logfile - --log-level info
# Alternative web server configurations (uncomment to use):
# web: gunicorn config.wsgi:application --bind 0.0.0.0:$PORT --workers 4 --threads 2 --timeout 120
# web: gunicorn config.wsgi:application --bind 0.0.0.0:$PORT --workers 2 --worker-class gevent --worker-connections 1000 --timeout 120
# web: gunicorn ..wsgi:application --bind 0.0.0.0:$PORT --workers 4 --threads 2 --timeout 120
# web: gunicorn ..wsgi:application --bind 0.0.0.0:$PORT --workers 2 --worker-class gevent --worker-connections 1000 --timeout 120
# Release task (runs migrations before deployment)
release: python manage.py migrate --noinput && python manage.py collectstatic --noinput
# Uncomment below to run scheduled tasks (if using Celery)
# worker: celery -A config worker --loglevel=info
# beat: celery -A config beat --loglevel=info
# worker: celery -A . worker --loglevel=info
# beat: celery -A . beat --loglevel=info
# Development server (for local testing with Foreman/Overmind)
# web: python manage.py runserver 0.0.0.0:$PORT
README.md
+51 -12
View File
@@ -1,6 +1,6 @@
# config
# .
A Django project created with django-setup.
A Django project created with [djinitx/djinit/dj](https://github.com/S4NKALP/djinit).
## Features
@@ -11,6 +11,22 @@ A Django project created with django-setup.
## Setup
### Using Just (Recommended)
1. Set environment variables in `.env` file
2. Run setup (installs dependencies, runs migrations, creates superuser):
```bash
just setup
```
3. Start development server:
```bash
just dev
```
### Traditional Method
1. Install dependencies:
```bash
pip install -r requirements.txt
@@ -33,31 +49,54 @@ A Django project created with django-setup.
python manage.py runserver
```
## Available Commands
Run `just` to see all available commands, including:
- `just dev` - Run development server
- `just migrate` - Run migrations
- `just makemigrations` - Create migrations
- `just createsuperuser` - Create superuser
- `just test` - Run tests
- `just lint` - Lint code
- `just format` - Format code
- `just shell` - Django shell
- `just clean` - Clean cache files
## Project Structure
```
config/
├── config/
./
├── src/
│ ├── settings/
│ │ ├── base.py
│ │ ├── development.py
│ │ └── production.py
│ ├── admin/
│ ├── api/ # API endpoints organized by model
│ │ ├── user/ # Example: if you have a User model
│ │ │ ├── views.py
│ │ │ ├── serializers.py
│ │ │ └── urls.py
│ │ └── urls.py
│ ├── models/ # Django models
│ ├── tests/
│ ├── urls.py
│ ├── wsgi.py
│ └── asgi.py
├── clients/
├── core/
├── finance/
├── productivity/
├── services/
├── core/
├── notifications/
├── projects/
├── manage.py
├── requirements.txt
├── pyproject.toml
├── .env.sample
└── README.md
**Note:** For the single folder layout, organize your API endpoints by model name under the `api/` directory.
For example, if you have a `User` model in `models/user.py`, create:
- `api/user/views.py` - API views for User
- `api/user/serializers.py` - Serializers for User
- `api/user/urls.py` - URL patterns for User endpoints
See the README files in `api/` and `models/` directories for more details.
```
## API Documentation
apps/clients/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class ClientsConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'clients'
apps/clients/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for clients app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'clients', views.ClientsViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/clients/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for clients app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class ClientsSerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/clients/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/clients/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'clients'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/clients/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
apps/core/admin.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.contrib import admin
# Register your models here.
apps/core/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class CoreConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'core'
apps/core/models.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.db import models
# Create your models here.
apps/core/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for core app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'core', views.CoreViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/core/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for core app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class CoreSerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/core/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/core/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'core'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/core/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
apps/finance/admin.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.contrib import admin
# Register your models here.
apps/finance/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class FinanceConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'finance'
apps/finance/models.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.db import models
# Create your models here.
apps/finance/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for finance app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'finance', views.FinanceViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/finance/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for finance app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class FinanceSerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/finance/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/finance/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'finance'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/finance/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
apps/notifications/admin.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.contrib import admin
# Register your models here.
apps/notifications/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class NotificationsConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'notifications'
apps/notifications/models.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.db import models
# Create your models here.
apps/notifications/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for notifications app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'notifications', views.NotificationsViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/notifications/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for notifications app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class NotificationsSerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/notifications/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/notifications/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'notifications'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/notifications/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
apps/productivity/admin.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.contrib import admin
# Register your models here.
apps/productivity/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class ProductivityConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'productivity'
apps/productivity/models.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.db import models
# Create your models here.
apps/productivity/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for productivity app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'productivity', views.ProductivityViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/productivity/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for productivity app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class ProductivitySerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/productivity/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/productivity/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'productivity'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/productivity/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
apps/projects/admin.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.contrib import admin
# Register your models here.
apps/projects/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class ProjectsConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'projects'
apps/projects/models.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.db import models
# Create your models here.
apps/projects/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for projects app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'projects', views.ProjectsViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/projects/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for projects app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class ProjectsSerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/projects/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/projects/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'projects'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/projects/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
apps/services/admin.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.contrib import admin
# Register your models here.
apps/services/apps.py
-8
View File
@@ -1,8 +0,0 @@
"""generated with djinit"""
from django.apps import AppConfig
class ServicesConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'services'
apps/services/models.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.db import models
# Create your models here.
apps/services/routes.py
-18
View File
@@ -1,18 +0,0 @@
"""
generated with djinit
API routes for services app.
"""
from rest_framework.routers import DefaultRouter
from . import views
# Create router instance
router = DefaultRouter()
# Register viewsets with router
# Example:
# router.register(r'services', views.ServicesViewSet)
# Get URL patterns
urlpatterns = router.urls
apps/services/serializers.py
-14
View File
@@ -1,14 +0,0 @@
"""
generated with djinit
serializers for services app.
"""
from rest_framework import serializers
# Add your serializers here
# Example:
# class ServicesSerializer(serializers.ModelSerializer):
# class Meta:
# model = YourModel
# fields = '__all__'
apps/services/tests.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.test import TestCase
# Create your tests here.
apps/services/urls.py
-11
View File
@@ -1,11 +0,0 @@
"""generated with djinit"""
from django.urls import path
from . import views
app_name = 'services'
urlpatterns = [
# Add your URL patterns here
# path('', views.index, name='index'),
]
apps/services/views.py
-5
View File
@@ -1,5 +0,0 @@
"""generated with djinit"""
from django.shortcuts import render
# Create your views here.
config/asgi.py
-10
View File
@@ -1,10 +0,0 @@
"""generated with djinit"""
import os
from dotenv import load_dotenv
from django.core.asgi import get_asgi_application
load_dotenv()
os.environ.setdefault("DJANGO_SETTINGS_MODULE", os.getenv("DJANGO_SETTINGS_MODULE", "core.settings.production"))
application = get_asgi_application()
config/settings/production.py
-57
View File
@@ -1,57 +0,0 @@
"""generated with djinit"""
from .base import *
import os
import dj_database_url
DEBUG = False
SECRET_KEY = os.getenv('SECRET_KEY')
ALLOWED_HOSTS = os.getenv('ALLOWED_HOSTS', '').split(',')
# Database
# Using individual database parameters
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': os.getenv('DB_NAME'),
'USER': os.getenv('DB_USER'),
'PASSWORD': os.getenv('DB_PASSWORD'),
'HOST': os.getenv('DB_HOST'),
'PORT': os.getenv('DB_PORT'),
}
}
# CORS settings for production
# Filter out empty strings from FRONTEND_URL
frontend_urls = os.getenv("FRONTEND_URL", "")
CORS_ALLOWED_ORIGINS = [
origin.strip() for origin in frontend_urls.split(",") if origin.strip()
]
CORS_ALLOW_CREDENTIALS = True
# Additional CORS security for production
CORS_ALLOW_PRIVATE_NETWORK = False
# Email settings
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = os.getenv('EMAIL_HOST')
EMAIL_PORT = int(os.getenv('EMAIL_PORT', 587))
EMAIL_USE_TLS = os.getenv('EMAIL_USE_TLS', 'True').lower() == 'true'
EMAIL_HOST_USER = os.getenv('EMAIL_HOST_USER')
EMAIL_HOST_PASSWORD = os.getenv('EMAIL_HOST_PASSWORD')
DEFAULT_FROM_EMAIL = os.environ.get("EMAIL_HOST_USER")
SERVER_EMAIL = os.environ.get("EMAIL_HOST_USER")
# Security settings for production
SECURE_SSL_REDIRECT = True
SECURE_HSTS_SECONDS = 31536000
SECURE_HSTS_INCLUDE_SUBDOMAINS = True
SECURE_HSTS_PRELOAD = True
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
# Session settings
SESSION_COOKIE_SECURE = True
CSRF_COOKIE_SECURE = True
# Static files
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
config/wsgi.py
-10
View File
@@ -1,10 +0,0 @@
"""generated with djinit"""
import os
from dotenv import load_dotenv
from django.core.wsgi import get_wsgi_application
load_dotenv()
os.environ.setdefault("DJANGO_SETTINGS_MODULE", os.getenv("DJANGO_SETTINGS_MODULE", "core.settings.production"))
application = get_wsgi_application()
justfile
+4 -4
View File
@@ -1,4 +1,4 @@
# Justfile for config
# Justfile for .
# Task runner for Django development
# Install just: https://github.com/casey/just
@@ -108,15 +108,15 @@ dbshell:
# Start production server with gunicorn
server:
uv run gunicorn config.wsgi:application --bind 0.0.0.0:8000
uv run gunicorn ..wsgi:application --bind 0.0.0.0:8000
# Start production server with gunicorn workers
server-prod WORKERS="4":
uv run gunicorn config.wsgi:application --bind 0.0.0.0:8000 --workers {{WORKERS}}
uv run gunicorn ..wsgi:application --bind 0.0.0.0:8000 --workers {{WORKERS}}
# Start production server with gunicorn and reload on file changes
server-watch:
uv run gunicorn config.wsgi:application --bind 0.0.0.0:8000 --reload
uv run gunicorn ..wsgi:application --bind 0.0.0.0:8000 --reload
# Clean Python cache files
clean:
manage.py
+5 -2
View File
@@ -6,7 +6,7 @@
import os
import sys
from dotenv import load_dotenv
import environ
def main():
@@ -25,5 +25,8 @@ def main():
if __name__ == "__main__":
load_dotenv()
env = environ.Env()
# Read .env file, if it exists
environ.Env.read_env()
main()
pyproject.toml
+6 -6
View File
@@ -7,15 +7,15 @@ requires-python = ">=3.13"
license = { text = "MIT" }
dependencies = [
"django",
"python-dotenv",
"django-environ",
"django-jazzmin",
"djangorestframework",
"djangorestframework-simplejwt",
"drf-spectacular",
"django-cors-headers",
"whitenoise",
"mysqlclient",
"psycopg2-binary",
"gunicorn",
"django-components>=0.143.2",
"django-htmx>=1.27.0",
"django-nepali-datetime-field>=0.8.0",
]
[tool.ruff]
@@ -38,4 +38,4 @@ ignore = [
]
[tool.ruff.lint.isort]
known-first-party = ["config"]
known-first-party = ["."]
requirements.txt
+2 -2
View File
@@ -3,13 +3,13 @@
#--------------------------------------------------#
Django
python-dotenv
django-environ
django-jazzmin
djangorestframework
djangorestframework_simplejwt
drf-spectacular
django-cors-headers
whitenoise
psycopg2-binary
mysqlclient
gunicorn
dj-database-url
apps/__init__.py → src/__init__.py
View File
File renamed without changes.
apps/clients/admin.py → src/admin/__init__.py
View File
File renamed without changes.
apps/clients/__init__.py → src/admin/base.py
View File
File renamed without changes.
apps/clients/migrations/__init__.py → src/admin/clients.py
View File
File renamed without changes.
apps/core/__init__.py → src/admin/finance.py
View File
File renamed without changes.
apps/core/migrations/__init__.py → src/admin/notifications.py
View File
File renamed without changes.
apps/finance/__init__.py → src/admin/productivity.py
View File
File renamed without changes.
apps/finance/migrations/__init__.py → src/admin/projects.py
View File
File renamed without changes.
apps/notifications/__init__.py → src/admin/services.py
View File
File renamed without changes.
src/api/README.md
+76
View File
@@ -0,0 +1,76 @@
# API Directory
This directory contains your API endpoints organized by model/resource.
## Structure
For each model in your `models/` directory, create a corresponding subdirectory here with the following files:
```
api/
├── __init__.py
├── urls.py # Main API URL router
└── <model_name>/ # e.g., user, product, order
├── __init__.py
├── views.py
├── serializers.py
└── urls.py
```
## Example
If you have a `User` model in `models/user.py`, create:
### 1. `api/user/serializers.py`
```python
from rest_framework import serializers
from src.models.user import User
class UserSerializer(serializers.ModelSerializer):
class Meta:
model = User
fields = '__all__'
```
### 2. `api/user/views.py`
```python
from rest_framework import viewsets
from src.models.user import User
from .serializers import UserSerializer
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
```
### 3. `api/user/urls.py`
```python
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import UserViewSet
router = DefaultRouter()
router.register(r'', UserViewSet, basename='user')
urlpatterns = [
path('', include(router.urls)),
]
```
### 4. Update `api/urls.py`
```python
from django.urls import path, include
urlpatterns = [
path('user/', include('src.api.user.urls')),
# Add more API endpoints here
]
```
## Best Practices
1. **One model per subdirectory**: Keep API endpoints for each model in its own subdirectory
2. **Consistent naming**: Use lowercase, plural names for API endpoints (e.g., `users/`, `products/`)
3. **Version your API**: Consider adding versioning (e.g., `api/v1/user/`)
4. **Use ViewSets**: Leverage DRF's ViewSets for standard CRUD operations
5. **Custom actions**: Add custom actions using `@action` decorator for non-CRUD operations
apps/notifications/migrations/__init__.py → src/api/__init__.py
View File
File renamed without changes.
apps/productivity/__init__.py → src/api/base/__init__.py
View File
File renamed without changes.
apps/productivity/migrations/__init__.py → src/api/base/urls.py
View File
File renamed without changes.
apps/projects/__init__.py → src/api/base/views.py
View File
File renamed without changes.
apps/projects/migrations/__init__.py → src/api/clients/__init__.py
View File
File renamed without changes.
apps/services/__init__.py → src/api/clients/urls.py
View File
File renamed without changes.
apps/services/migrations/__init__.py → src/api/clients/views.py
View File
File renamed without changes.
config/__init__.py → src/api/finance/__init__.py
View File
File renamed without changes.
config/settings/__init__.py → src/api/finance/urls.py
View File
File renamed without changes.
src/api/finance/views.py
View File
Whitespace-only changes.
src/api/notifications/__init__.py
View File
Whitespace-only changes.
src/api/notifications/urls.py
View File
Whitespace-only changes.
src/api/notifications/views.py
View File
Whitespace-only changes.
src/api/productivity/__init__.py
View File
Whitespace-only changes.
src/api/productivity/urls.py
View File
Whitespace-only changes.
src/api/productivity/views.py
View File
Whitespace-only changes.
src/api/projects/__init__.py
View File
Whitespace-only changes.
src/api/projects/urls.py
View File
Whitespace-only changes.
src/api/projects/views.py
View File
Whitespace-only changes.
src/api/services/__init__.py
View File
Whitespace-only changes.
src/api/services/urls.py
View File
Whitespace-only changes.
src/api/services/views.py
View File
Whitespace-only changes.
src/asgi.py
+11
View File
@@ -0,0 +1,11 @@
"""generated with djinit"""
import os
import environ
from django.core.asgi import get_asgi_application
env = environ.Env()
environ.Env.read_env()
os.environ.setdefault("DJANGO_SETTINGS_MODULE", env("DJANGO_SETTINGS_MODULE", default="core.settings.production"))
application = get_asgi_application()
src/models/README.md
+119
View File
@@ -0,0 +1,119 @@
# Models Directory
This directory contains your Django models.
## Structure
Organize your models as individual Python files:
```
models/
├── __init__.py
├── user.py
├── product.py
└── order.py
```
## Creating a Model
### 1. Create the model file (e.g., `models/user.py`)
```python
from django.db import models
from django.contrib.auth.models import AbstractUser
class User(AbstractUser):
"""Custom user model."""
bio = models.TextField(blank=True)
avatar = models.ImageField(upload_to='avatars/', blank=True, null=True)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Meta:
db_table = 'users'
verbose_name = 'User'
verbose_name_plural = 'Users'
def __str__(self):
return self.username
```
### 2. Import in `models/__init__.py`
```python
from .user import User
from .product import Product
from .order import Order
__all__ = ['User', 'Product', 'Order']
```
### 3. Create corresponding API endpoints
After creating a model, create the corresponding API structure in the `api/` directory:
```
api/
└── user/
├── __init__.py
├── views.py
├── serializers.py
└── urls.py
```
See the `api/README.md` for detailed instructions on creating API endpoints.
### 4. Register in admin (optional)
Create or update `admin/__init__.py`:
```python
from django.contrib import admin
from src.models import User
@admin.register(User)
class UserAdmin(admin.ModelAdmin):
list_display = ['username', 'email', 'created_at']
search_fields = ['username', 'email']
list_filter = ['is_active', 'created_at']
```
## Best Practices
1. **One model per file**: Keep each model in its own file for better organization
2. **Use meaningful names**: Choose clear, descriptive names for models and fields
3. **Add Meta class**: Define `db_table`, `verbose_name`, and other metadata
4. **Implement __str__**: Always define a meaningful `__str__` method
5. **Use mixins**: Create reusable mixins for common fields (e.g., timestamps)
6. **Add docstrings**: Document your models with clear docstrings
## Common Model Patterns
### Timestamped Model Mixin
```python
class TimestampedModel(models.Model):
"""Abstract base class with timestamp fields."""
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Meta:
abstract = True
```
### Soft Delete Mixin
```python
class SoftDeleteModel(models.Model):
"""Abstract base class with soft delete functionality."""
is_deleted = models.BooleanField(default=False)
deleted_at = models.DateTimeField(null=True, blank=True)
class Meta:
abstract = True
def delete(self, *args, **kwargs):
self.is_deleted = True
self.deleted_at = timezone.now()
self.save()
```
Loaded 100 of 116 files, more files were not shown because too many files have changed in this diff. Show more