{"id":23818852,"url":"https://github.com/dev-lymar/melnichanka","last_synced_at":"2025-08-26T08:09:06.365Z","repository":{"id":214170637,"uuid":"735673343","full_name":"dev-lymar/Melnichanka","owner":"dev-lymar","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-25T09:53:20.000Z","size":1443,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-13T11:55:52.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dev-lymar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-25T19:14:25.000Z","updated_at":"2024-05-13T11:55:57.181Z","dependencies_parsed_at":"2024-03-29T22:27:31.067Z","dependency_job_id":"7b42a007-7ee4-41cf-a6c7-f386bfab553f","html_url":"https://github.com/dev-lymar/Melnichanka","commit_stats":null,"previous_names":["kroshkabyte/melnichanka","dev-lymar/melnichanka"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dev-lymar/Melnichanka","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-lymar%2FMelnichanka","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-lymar%2FMelnichanka/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-lymar%2FMelnichanka/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-lymar%2FMelnichanka/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dev-lymar","download_url":"https://codeload.github.com/dev-lymar/Melnichanka/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-lymar%2FMelnichanka/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272192669,"owners_count":24889452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-02T06:18:37.313Z","updated_at":"2025-08-26T08:09:06.219Z","avatar_url":"https://github.com/dev-lymar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Python](https://img.shields.io/badge/Python-3.12.2-3776AB?style=flat\u0026logo=Python\u0026logoColor=yellow)](https://www.python.org/)\n[![Django REST Framework](https://img.shields.io/badge/Django%20REST%20Framework-3.15.1-092E20?style=flat\u0026logo=django\u0026logoColor=white)](https://www.django-rest-framework.org/)\n[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16.3-336791?style=flat\u0026logo=PostgreSQL\u0026logoColor=white)](https://www.postgresql.org/)\n[![Redis](https://img.shields.io/badge/Redis-7.2.5-DC382D?style=flat\u0026logo=Redis\u0026logoColor=white)](https://redis.io/)\n[![Celery](https://img.shields.io/badge/Celery-5.4-37814A?style=flat\u0026logo=Celery\u0026logoColor=white)](https://docs.celeryq.dev/)\n[![RabbitMQ](https://img.shields.io/badge/RabbitMQ-3.13.3-FF6600?style=flat\u0026logo=RabbitMQ\u0026logoColor=white)](https://www.rabbitmq.com/)\n[![Docker](https://img.shields.io/badge/Docker--2496ED?style=flat\u0026logo=Docker\u0026logoColor=white)](https://www.docker.com/)\n[![Nginx](https://img.shields.io/badge/Nginx-3.17-269539?style=flat\u0026logo=Nginx\u0026logoColor=white)](https://www.nginx.com/)\n[![Psycopg2-binary](https://img.shields.io/badge/Psycopg2--binary-2.9.9-4169E1?style=flat)](https://pypi.org/project/psycopg2-binary/)\n[![Gunicorn](https://img.shields.io/badge/Gunicorn-21.2-FFD700?style=flat\u0026logo=Gunicorn\u0026logoColor=white)](https://gunicorn.org/)\n[![pytest](https://img.shields.io/badge/pytest-8.0.2-0A9EDC?style=flat\u0026logo=pytest\u0026logoColor=white)](https://docs.pytest.org/)\n[![Ruff](https://img.shields.io/badge/Ruff-0.3-FCC21B?style=flat\u0026logo=ruff\u0026logoColor=white\"/)](https://github.com/astral-sh/ruff)\n[![SimpleJWT](https://img.shields.io/badge/SimpleJWT-5.3.1-orange?style=flat\u0026logo=jwt\u0026logoColor=white)](https://github.com/jazzband/djangorestframework-simplejwt)\n[![pre-commit](https://img.shields.io/badge/precommit-0.2-FAB040?style=flat\u0026logo=precommit\u0026logoColor=white)](https://pre-commit.com/)\n[![Flake8](https://img.shields.io/badge/flake8-checked-blueviolet?style=flat)](https://flake8.pycqa.org/en/latest/)\n[![mypy](https://img.shields.io/badge/mypy-checked-blue?style=flat)](https://mypy-lang.org/)\n\n# Melnichanka\n\n## Table of Contents\n\n- [Project Description](#project-description)\n- [How to run the project](#how-to-run-the-project)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Testing](#testing)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Project Description\n\n***Melnichanka: Simplifying Shipment Application Submissions***\n\nMelnichanka is a web application designed to streamline the process of submitting shipment\napplications. It automates the generation of necessary documents based on user input, covering\ndetails such as goods, brands, factories, and packages.\n\n***Key Benefits:***\n\n- Efficiency: Automates document generation to save time and resources.\n- Accuracy: Reduces errors associated with manual data entry.\n- Accessibility: User-friendly interface ensures ease of use, suitable for all levels of technical\n  proficiency.\n- Convenience: Simplifies the submission process, even for users with minimal technical experience.\n\n***Technological Foundation:***\n\n- Built with Django: Utilizes the robust Django framework for Python, ensuring reliability and\n  flexibility.\n- Containerized with Docker: Deployed using Docker and Docker Compose, enabling easy scalability\n  and\n  deployment.\n\n***Target Audience:***\n\nDesigned for companies needing to submit shipment applications regularly.\nIdeal for organizations seeking to enhance efficiency, minimize errors, and optimize resource\nallocation.\n\n***Conclusion:***\n\nMelnichanka empowers companies by automating the creation of shipment documents, enabling them to\nfocus on core business activities. It stands as a powerful tool for improving operational\nefficiency and streamlining document submission processes.\n\n## How to run the project\n\n1. Install [`Docker`](https://www.docker.com/)\n   and [`Docker Compose`](https://docs.docker.com/compose/)\n   To get started with Melnichanka, you will need to have [Docker](https://www.docker.com/)\n   and [Docker Compose](https://docs.docker.com/compose/) installed on your system. You can follow\n   the instructions for your operating system here and here.\n\nOnce you have [Docker](https://www.docker.com/)\nand [Docker Compose](https://docs.docker.com/compose/) installed, follow these steps to start the\nproject:\n\n- Clone the repository:\n\n```sh\ngit clone https://github.com/KroshkaByte/Melnichanka.git\ncd Melnichanka\n```\n\n- [Configure .env](#environment-configuration)\n\n\u003cp\u003e\n\n- Start the project from root directory:\n\n```sh\ndocker-compose up -d --build\n```\n\n- Open your web browser and navigate to http://localhost:80 to access the application.\n\n#### Environment Configuration\n\nYou need to manually update this secret in your `.env` file each time it changes.\n\nAdditionally, create a `.env` file in the root directory based on the provided `.env.example`. Fill\nin your own data and rename the file to `.env`.\n\nPlease note that the Django secret key used in the `.env.example` is just an example. You can\ngenerate a new key using the following command:\n\n   ```sh\n   from django.core.management.utils import get_random_secret_key\n   \n   print(get_random_secret_key())\n   ```\n\n## Usage\n\nTo use Melnichanka, follow these steps:\n\n- Enter the required information about the goods, brands, factories, and packages.\n- Click the `Generate Documents` button to generate the package of documents required for shipment.\n- Verify all the data and create an archive with documents.\n- Download the archive of documents in Excel format.\n- Submit the documents to the consignee as required.\n\n## Database Pre-population\n\nTo pre-populate the database with some initial data, you can use the provided script. This script\nutilizes the `Faker` library to generate fake data.\n\nPlease follow the steps below to run the script:\n\n- Navigate to the root directory of the project in your terminal.\n\n- Run the following command:\n\n```sh\npython3 manage.py runscript faker_script\n```\n\nMake sure `django-extensions` is installed and added to `INSTALLED_APPS` in your Django settings.\n\nThis command will execute the `faker_script` script, which will then populate the database with the\ngenerated data.\n\nPlease note that the data generated by the Faker library is random and does not represent any real\ninformation.\n\nEnsure that your `virtual environment` is activated before running the commands, if you're using\none.\n\n## Documentation\n\nAPI documentation is available through Swagger UI and ReDoc.\n\n- [Swagger UI](https://dev-lymar.github.io/Melnichanka/melnichanka_swager_ui)\n- [ReDoc](https://dev-lymar.github.io/Melnichanka/melnichanka_redoc)\n\nFor local access, navigate to [`Swagger UI`](http://localhost:8000/api/schema/swagger-ui/)\nand [`ReDoc`](http://localhost:8000/api/schema/redoc/) in your browser after starting the project.\n\n## Testing\n\nTo run the tests, navigate to the root directory of the project (where the manage.py file is\nlocated) and run the following command:\n\n```sh\npytest .\n```\n\nor\n\n```sh\npython3 -m pytest .\n```\n\n- To run tests for a specific application (such as goods, logistics, users, etc.) use the following\n  command:\n\n```sh\npytest goods\npytest logistics\npytest users\npytest clients\npytest makedoc\n```\n\n## Contributing\n\nWe welcome contributions to Melnichanka. To contribute:\n\n1. Fork the repository.\n2. Create a new branch for your changes.\n3. Make your changes and commit them to your branch.\n4. Update your branch from the main repository:\n    ```sh\n    git fetch upstream\n    git merge upstream/main\n    ```\n\n5. Submit a pull request.\n\nWe will review your pull request and provide feedback as needed.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-lymar%2Fmelnichanka","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdev-lymar%2Fmelnichanka","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-lymar%2Fmelnichanka/lists"}