Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syedfaiqueali/django-base-code

Ready to use code base of django framework
https://github.com/syedfaiqueali/django-base-code

Last synced: 8 days ago
JSON representation

Ready to use code base of django framework

Host: GitHub
URL: https://github.com/syedfaiqueali/django-base-code
Owner: syedfaiqueali
Created: 2023-07-28T13:56:07.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-07-17T07:24:27.000Z (4 months ago)
Last Synced: 2024-10-07T19:41:15.118Z (about 1 month ago)
Language: Python
Size: 58.6 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Django-base-code

This repo contains ready-to use base code for django applications.

## Features

- Custom User Module with Auth
- Unit Test Cases
- 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

## Prerequisites

- Python 3.9
- Docker
- VScode
## How to use?

**To build docker image**

```bash
docker-compose build
```

**To run app**

```bash
docker-compose up
```

**To stop app**

```bash
docker-compose down
```

**To execute tests**

```bash
docker-compose run --rm app sh -c "python manage.py test"
```
## Authors

- [Faique Ali](https://www.github.com/faiqueali017)

## Contributing

Contributions are always welcome!

- Create your Work Branch `git checkout -b dev/`
- Commit your Changes `git commit -m ''`
- Push to the Branch `git push origin dev/`
- Open a Pull Request

Please adhere to this project's `code of conduct`.
## 🔗 Connect Me
[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:[email protected])

[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/faique-ali/)