ravenscroftj
/
django-project-structure
mirror of https://github.com/saqibur/django-project-structure.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #16 from Gustavo-Gadelha/fix/update-readme 

Minor grammar fixes to README.md
This commit is contained in:
Saqibur Rahman 2024-07-29 15:05:23 +06:00 committed by GitHub
parent b312fc7167 a67ed9582f
commit f9ce7f2c73
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -24,7 +24,7 @@ anything you see fit.
1. Run the project using `python manage.py runserver` and you should see the
default success page provided by Django at
[http://127.0.0.1:8000/](http://127.0.0.1:8000/).
1. [Optional] If you want to configure database, in the `DATABASE` section of `settings.py` we have added `postgresql` as the default `DATABASE` (As most of the application are using it). You can rollback to the `sqlite` by adding the following code snippet, removing the current one.
1. [Optional] If you want to configure database, in the `DATABASE` section of `settings.py` we have added `postgresql` as the default `DATABASE` (As most of the application are using it). You can roll back to the `sqlite` by adding the following code snippet, removing the current one.
```bash
DATABASES = {
@ -95,7 +95,6 @@ project
│ ├── local.txt # Only for a local server (example: docs, performance testing, etc.)
│ └── production.txt # Production only
├── static/ # Your static files
├── static/ # Your static files
├── .env.example # An example of your .env configurations. Add necessary comments.
├── .gitignore # https://github.com/github/gitignore/blob/main/Python.gitignore
├── entrypoint.sh # Any bootstrapping necessary for your application
@ -114,7 +113,7 @@ into any other project and it’ll work independently.
* A mother-folder containing all apps for our project. Congruent to any
JS-framework's `src` folder. If you really wanted to, you could even call it the
`src` folder. Again, it's up to you.
* An app can be a django template project, or an rest framework API.
* An app can be a django template project, or a rest framework API.
### `services`
* We’ll be writing business logic in services instead of anywhere else.
@ -159,7 +158,7 @@ endpoints to ensure full compatibility.
#### What's `v2` of an API?
Currently we're proposing that major changes to the following, constitutes a new API version:
Currently, we're proposing that major changes to the following constitutes a new API version:
1. Representation of data, either for submission or retrieval
1. Major optimizations
1. Major code reorganization and code refactor