-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3936674
commit 60551a4
Showing
59 changed files
with
1,729 additions
and
1,834 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,6 @@ | ||
# Elevate-BE | ||
|
||
# Django-base-code | ||
|
||
This repo contains ready-to use base code for django applications. | ||
|
||
This repo contains code base code for django. | ||
|
||
## Features | ||
|
||
|
@@ -11,19 +9,14 @@ This repo contains ready-to use base code for django applications. | |
- PostgreSQL | ||
- Docker | ||
- Ready to deploy configs | ||
- Github Actions | ||
- Swagger (API Docs) | ||
- Ready to use as a base code | ||
- Usage Examples | ||
- Example:01 - Recipe, Ingredients, Recipe-Tags APIs | ||
- Example:02 - *[Work in Process]* E-commerce APIs | ||
|
||
- Bitbucket pipelines | ||
|
||
## Prerequisites | ||
|
||
- Python 3.9 | ||
- Python 3.10 | ||
- Docker | ||
- VScode | ||
|
||
## How to use? | ||
|
||
**To build docker image** | ||
|
@@ -44,15 +37,42 @@ This repo contains ready-to use base code for django applications. | |
docker-compose down | ||
``` | ||
|
||
**To create new app** | ||
|
||
```bash | ||
docker-compose run --rm app sh -c "python manage.py startapp <app-name>" | ||
``` | ||
|
||
**To migrate database schema** | ||
|
||
```bash | ||
docker-compose run --rm app sh -c "python manage.py makemigrations" | ||
docker-compose run --rm app sh -c "python manage.py migrate" | ||
``` | ||
|
||
**To create superuser** | ||
|
||
```bash | ||
docker-compose run --rm app sh -c "python manage.py createsuperuser" | ||
``` | ||
|
||
**To execute tests** | ||
|
||
```bash | ||
docker-compose run --rm app sh -c "python manage.py test" | ||
``` | ||
## Authors | ||
|
||
- [Faique Ali](https://www.github.com/faiqueali017) | ||
**To check linting** | ||
|
||
```bash | ||
docker-compose run --rm app sh -c "flake8" | ||
``` | ||
|
||
**To format code** | ||
|
||
```bash | ||
docker-compose run --rm app sh -c "black ." | ||
``` | ||
|
||
## Contributing | ||
|
||
|
@@ -64,7 +84,3 @@ Contributions are always welcome! | |
- Open a Pull Request | ||
|
||
Please adhere to this project's `code of conduct`. | ||
## 🔗 Connect Me | ||
[](mailto:[email protected]) | ||
|
||
[](https://www.linkedin.com/in/faique-ali/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
|
||
[flake8] | ||
exclude = | ||
migrations, | ||
__pycache__, | ||
manage.py, | ||
settings.py | ||
settings.py, | ||
migrations, | ||
manage.py | ||
|
||
max-line-length = 88 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.