https://github.com/vitaee/apexivedjangotask

Applied the best practices of Django and Python, paying close attention to the specific requirements.
https://github.com/vitaee/apexivedjangotask

Last synced: 14 days ago
JSON representation

Applied the best practices of Django and Python, paying close attention to the specific requirements.

• Host: GitHub
• URL: https://github.com/vitaee/apexivedjangotask
• Owner: Vitaee
• Created: 2024-08-07T20:24:04.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-08T20:02:49.000Z (5 months ago)
• Last Synced: 2024-11-06T19:50:45.491Z (2 months ago)
• Language: Python
• Homepage:
• Size: 397 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Apexive Django Task

This assignment is designed to evaluate your skills and approach as a Senior Architect. We expect you to  apply the best practices of Django and Python, paying close attention to the specific requirements.

# Project Structure

The project structure help us to understand the project itself better. We're not focusing only coding we also should focus the project structure and the documentation. Added postman collection also. You can see sample requests.

Here is the typical top-level directory layout four our project:

    

    ├── compose          # compose folder contains necessary Dockerfiles.

    |   ├── django       # contains app dockerfile for django.

    |   ├── postgres     # contains db dockerfile for db service.

    |   |── nginx        # contains nginx conf.

    ├── envs             # contains all env files used by our project.

    ├── src              # contains all source files (`project folder`, `apps` etc.)

    |   |── applications # contains all project's apps.

    └── README.md        # contains all information about the project.

# Used Techs

This project uses below techs & libraries to enchance performance and rapid development as well as best practices.

- Docker

- Pytest

- Celery

- Redis ( may use dragonfly to improve caching performance )

- Logging

- Realworld project structure.

# Import Or Export Data

To export data simply run below command:

- python manage.py export_data

To import data simply run below command:

- python manage.py import_data

# How I Setup Project

To setup project initially i ran below command:

- django-admin startproject apexive

Then i created my first app with below command:

- python manage.py startapp core

Then i created necessary docker compose files and dockerfiles to dockerize my project. Then i could build my dockerized project with below command:

- docker compose build

Then i simply run my project with below command:

- docker compose up

# Running Tests

You can run the unit tests with below commands firstly we should connect our docker container:

- docker exec -it csvparser-web-2 bash

Then we can run the unit tests with below commands:

- python manage.py test

OR

- pytest -s applications/pilotlog/tests.py