Account Manager

screenshot of Account Manager

this is a project for control of accounts in small business (Ex.: bakery, grocery store, pastry shop).

Overview

The ACCOUNT-MANAGER tool is a project designed for the internal management of micro-businesses. It utilizes the Django admin site as a base for its functionalities. It is important to note that this tool is not recommended for managing large or large-scale businesses.

Features

  • Internal management of micro businesses
  • Utilizes the Django admin site
  • Designed for small-scale businesses

Initial steps

  1. Open your terminal
  2. Create a folder
  3. Go to this folder
  4. With Git installed, run the following command:
git clone <repository_url>

Install locally

If you want to run the tool locally, follow these steps:

  1. Make sure Python is installed on your system
  2. Create a virtual environment
    • For Windows:
      python -m venv <env_name>
      
    • For Mac/Linux:
      python3 -m venv <env_name>
      
  3. Activate the virtual environment
    • For Windows:
      <env_name>\Scripts\activate
      
    • For Mac/Linux:
      source <env_name>/bin/activate
      
  4. Install the dependencies
    • For Windows:
      pip install -r requirements.txt
      
  5. Create a .env file according to the provided .env.example file
    • Refer to the official documentation of Django for more details
  6. Perform the migrations by running the following command:
    • For Windows:
      python manage.py migrate
      
  7. The tool is now ready to use. Access localhost:8000 in your browser to use it.

Install in a Docker container

If you want to run the tool in a Docker container, follow these steps:

  1. Make sure Docker and Docker Compose are installed on your system
  2. Run the following commands:
    docker-compose up -d --build
    
  3. Copy the ID of the 'application' container
  4. Run the following command to access the container shell:
    • For Windows:
      docker exec -it <container_id> bash
      
  5. The tool is now running in the Docker container.

Final steps

After the installation, you can perform the following steps:

  1. Create a superuser for the system by running the following command:
    • For Windows:
      python manage.py createsuperuser
      
  2. Enter the username and password for the superuser you want to create.
  3. Congratulations! You can now use the system.

Summary

The ACCOUNT-MANAGER tool is a project developed for the internal management of micro businesses. It offers features such as utilizing the Django admin site and is recommended for small-scale businesses. The installation process includes setting up the tool locally or in a Docker container, performing migrations, and creating a superuser for system access.