Clean Code Project

Objective

The objective of this project is to ensure the codebase follows clean code principles, enhancing readability, maintainability, and scalability.

Installation

1. Clone the Repository

   git clone https://github.com/Arbiter-S/task-clean-code.git

2. Make a virtual environment(Optional) This step is optional but recommended to avoid conflicts with other packages you might have installed.

   python -m venv venv
   source venv/bin/activate # Unix based systems

Starting the project

This project uses docker and has a docker-compose.yml file so starting it has no complications and can done using a single command. Before proceeding make sure you have Docker installed and have it running on your machine.

cd project_directory
docker-compose up

Conclusion

That wraps up the Clean Code Project. Thank you for your attention.