SimpleAccounts
  • ๐Ÿ‘‹Welcome to SimpleAccounts
  • Overview
    • ๐Ÿ’กWhat we do
    • โœจKey Features
  • Getting Started
    • ๐Ÿ–ฅ๏ธSelf-Hosted Service
    • ๐Ÿ› ๏ธInstallation Guide
      • Docker
      • Linux OS
      • Mac OS
      • Windows
      • ๐Ÿ“Setting permissions
      • ๐Ÿง‘Inviting Members
    • ๐Ÿง‘โ€๐Ÿ’ปManaged Service
  • Product Guides
    • ๐Ÿ’ธIncome
      • ๐Ÿ“Customer Invoices
        • ๐Ÿ”นCreate and send invoices to a customer
        • ๐Ÿ”นSend invoices to a customer
        • ๐Ÿ”นCheck the status of an invoice
        • ๐Ÿ”นEdit the payment details on an invoice
        • ๐Ÿ”นUpdate payment details on an invoice which is already sent (for which no payment has been recorded)
        • ๐Ÿ”นManually record payment on a customer invoice
        • ๐Ÿ”นChange date on an invoice
        • ๐Ÿ”นDelete an invoice
        • ๐Ÿ”นSort invoices dating oldest to newest
        • ๐Ÿ”นView paid invoices
      • ๐ŸงพIncome Receipts
        • ๐Ÿ”นView invoices as receipts
      • ๐Ÿ“ƒQuotations
        • ๐Ÿ”นCreate a quotation
        • ๐Ÿ”นSend a quotation to a potential customer
    • ๐Ÿ’ฒExpense
      • ๐Ÿ’ตExpenses
        • ๐Ÿ”นManually add Expenses
        • ๐Ÿ”นSend an expense note to the payee
      • ๐Ÿ“„Supplier Invoices
        • ๐Ÿ”นCreate and send an invoice to a supplier
        • ๐Ÿ”นSend invoices to a supplier
        • ๐Ÿ”นEdit the payment details on a supplier invoice
        • ๐Ÿ”นDelete a supplier invoice
        • ๐Ÿ”นUpdate payment details for an already sent supplier invoice (with no recorded payment)
        • ๐Ÿ”นDelete paid supplier invoice
      • ๐ŸงพPurchase Receipts
        • ๐Ÿ”นView supplier invoices as receipts
    • ๐ŸฆBanking
      • ๐ŸฆManage Bank Accounts
        • ๐Ÿ”นAdd bank account to SimpleAccounts
        • ๐Ÿ”นEdit or update details of a bank account
        • ๐Ÿ”นDelete a bank account
      • ๐Ÿ’ฑManage Transactions
        • ๐Ÿ”นAdd a transaction
        • ๐Ÿ”นCreate new parsing template to import bank statement.
        • ๐Ÿ”นImport a transaction from your computer
        • ๐Ÿ”นReconcile a transaction
        • ๐Ÿ”นMatch transaction with books / Explain a transaction
        • ๐Ÿ”นUnmatch transaction with books /Unexplain a transaction
        • ๐Ÿ”นMatch an Invoice with Bank Transaction
        • ๐Ÿ”นCreate new parsing template to import bank statement
    • ๐Ÿ‘จโ€๐Ÿ’ผAccountant
      • โš–๏ธOpening Balance
        • ๐Ÿ”นView opening balance of all the transactions
        • ๐Ÿ”นAdd an opening balance manually
      • ๐Ÿ“–Journal
        • ๐Ÿ”นView journals
        • ๐Ÿ”นManually add a journal entry
    • ๐Ÿ“ŠReports
      • ๐Ÿ”นView a Financial Report
      • ๐Ÿ”นExport or download a report
      • ๐Ÿ”นPrint a Report
      • ๐Ÿ”นView Profit and Loss Report
      • ๐Ÿ”นView a report during a specific date.
    • ๐Ÿ’ฐMaster
      • ๐Ÿ“‹Chart of Accounts
        • ๐Ÿ”นCategorize transactions
        • ๐Ÿ”นAdd Chart of Accounts
        • ๐Ÿ”นEdit the type of transaction in chart of accounts
        • ๐Ÿ”นDelete an account from the chart of accounts
      • ๐Ÿ‘คContact
        • ๐Ÿ”นAdd a customer
        • ๐Ÿ”นEdit the details of a customer
        • ๐Ÿ”นDelete a customer
        • ๐Ÿ”นAdd a supplier
        • ๐Ÿ”นDelete a supplier
      • ๐Ÿ“ฆProduct
        • ๐Ÿ”นAdd a product
        • ๐Ÿ”นUpdate the VAT details of a product
        • ๐Ÿ”นChange the product category of a product
        • ๐Ÿ”นDelete a product
      • ๐Ÿ—ƒ๏ธProduct Category
        • ๐Ÿ”นCreate a product category
        • ๐Ÿ”นEdit product category
        • ๐Ÿ”นChange the Code of a Product category
        • ๐Ÿ”นDelete a product category
      • ๐Ÿ’ผVAT Category
        • ๐Ÿ”นAdd a VAT category
        • ๐Ÿ”นEdit VAT category
        • ๐Ÿ”นDelete a VAT category
      • ๐Ÿ’ฑCurrency Rate
        • ๐Ÿ”นAdd a currency rate conversion to UAE dirham
        • ๐Ÿ”นAdd the currency rate from Indian rupee to UAE dirham
        • ๐Ÿ”นUpdate the exchange rate of a currency
        • ๐Ÿ”นDelete a currency rate
      • ๐Ÿ‘จโ€๐Ÿ’ผEmployee
        • ๐Ÿ”นAdd an employee
        • ๐Ÿ”นView, send or download Payslip
    • ๐Ÿ“ฆInventory
      • ๐Ÿ”นView Inventory
      • ๐Ÿ”นAdd product to inventory
      • ๐Ÿ”นView a productโ€™s stock in hand
    • ๐Ÿ‘ฅPayroll
      • ๐Ÿ“ƒPayroll Configuration
        • ๐Ÿ”นAdd New Employee Designation
        • ๐Ÿ”นAdd Company Details
        • ๐Ÿ”นAdd an employee for Payroll
      • ๐Ÿ…ฟ๏ธRun Payroll
        • ๐Ÿ”นCreate a payroll
        • ๐Ÿ”นApprove a Payroll
        • ๐Ÿ”นReject a Payroll
        • ๐Ÿ”นUpdate a rejected payroll
        • ๐Ÿ”นView, send or download Payslip
        • ๐Ÿ”นVoid an approved payroll
        • ๐Ÿ”นGet the salary information file of the employees
Powered by GitBook
On this page
  • Prerequisites
  • Git Installation
  • Installing Docker on macOS
  • Installing Docker Compose on Mac OS
  • Installation
  • Environment Variables

Was this helpful?

  1. Getting Started
  2. Installation Guide

Mac OS

SimpleAccounts-UAE is a web application for managing accounts. This README provides instructions for installing and running SimpleAccounts-UAE using Docker and Docker Compose.

PreviousLinux OSNextWindows

Last updated 1 year ago

Was this helpful?

Prerequisites


Before proceeding with the installation, please make sure you have the following prerequisites installed:

Here are detailed instructions to install Docker and Docker Compose on Mac OS:

  • Git:

  • Docker:

  • Docker Compose:

Git Installation


Installing Git on macOS is a straightforward process

  1. Using Homebrew (Recommended): Homebrew is a popular package manager for macOS that makes it easy to install and manage various software, including Git.

  • Open the Terminal. You can find it in the Applications folder under Utilities, or you can use Spotlight (Cmd + Space) and search for "Terminal."

  • If you don't have Homebrew installed, you can install it by running the following command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • Once Homebrew is installed, you can install Git by running:

brew install git
  1. Xcode Command Line Tools: Git is also available through the Xcode Command Line Tools, which can be installed as follows:

  • Open Terminal.

  • Run the following command:

xcode-select --install
  • A dialog will appear asking if you want to install the tools. Click "Install."

  1. Verify Installation:

  • After installation, you can verify Git is correctly installed by opening a terminal and running:

git --version

Installing Docker on macOS


  1. Click on the "Get Docker" button.

  2. On the next page, select "Docker Desktop for Mac" to download the installer.

  3. Once the download is complete, open the installer package (.dmg file).

  4. Drag and drop the Docker.app icon into the Applications folder to install Docker.

  5. Launch Docker by clicking on the Docker icon in the Applications folder.

  6. Docker may prompt you for system-level permissions. Enter your macOS user password to authorize Docker.

  7. Docker Desktop will start up, and you'll see the Docker icon appear in the macOS menu bar.

  8. Docker may take a few minutes to initialize. Once it's ready, you'll see the Docker status as "Docker is running" in the menu bar.

  9. Click on the Docker icon in the menu bar and select "Preferences" to access Docker settings. From there, you can customize various configurations such as resources, network, and more. You can review and adjust these settings according to your needs.

  10. Docker is now installed on your macOS machine. You can open a terminal window and run docker --version to verify the installation. It should display the Docker version number.

Installing Docker Compose on Mac OS


  1. Open a terminal window.

  2. Run the following command to download the Docker Compose binary:

curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

This command retrieves the latest release of Docker Compose and saves it to the /usr/local/bin/docker-compose location.

  1. After the download completes, run the following command to make the docker-compose binary executable:

chmod +x /usr/local/bin/docker-compose
  1. Verify the installation by running docker-compose --version in the terminal. It should display the Docker Compose version number.

Docker and Docker Compose are now successfully installed on your macOS machine. You can proceed with using them as described in your project's README.md file or other relevant documentation.

Note: Make sure to restart your computer after installing Docker and Docker Compose to ensure that all changes take effect properly.

To verify if Docker and Docker Compose are installed correctly, run the following commands:

docker --version
docker-compose --version

Make sure you see the version numbers for both commands.

Installation


  1. Clone the SimpleAccounts-UAE repository:

git clone https://github.com/SimpleAccounts/SimpleAccounts-UAE.git
cd SimpleAccounts-UAE
  1. Open the docker/docker-compose.yml file and review the environment variables defined under the backend service section. These variables control various aspects of the application, including SMTP configuration and database settings. It is recommended to change the default values, especially for sensitive information such as passwords.

  2. Start the application using Docker Compose:

docker-compose up -d

This command will download the required Docker images and start the containers in the background.

Environment Variables


The following environment variables can be configured in the docker/docker-compose.yml file under the backend service section:

  • SIMPLEVAT_SMTP_USER: SMTP username for sending emails.

  • SIMPLEVAT_SMTP_PASS: SMTP password for authentication.

  • SIMPLEVAT_SMTP_HOST: SMTP server hostname.

  • SIMPLEVAT_SMTP_PORT: SMTP server port.

  • SIMPLEVAT_SMTP_AUTH: SMTP authentication method.

  • SIMPLEVAT_SMTP_STARTTLS_ENABLE: Enable STARTTLS for SMTP connection.

  • SIMPLEVAT_RELEASE: Application release version.

  • SIMPLEVAT_HOST: Application host URL.

  • SIMPLEVAT_DB_HOST: Hostname of the PostgreSQL database.

  • SIMPLEVAT_DB: Name of the PostgreSQL database.

  • SIMPLEVAT_DB_USER: PostgreSQL database username.

  • SIMPLEVAT_DB_PASSWORD: PostgreSQL database password.

  • SIMPLEVAT_DB_PORT: PostgreSQL database Port number.

It is recommended to review and update these variables according to your specific configuration.

Note: Please ensure that sensitive information, such as passwords, are stored securely and not committed to version control.

Visit the Docker website:

Access the SimpleAccounts-UAE application by opening your web browser and navigating to .

๐Ÿ› ๏ธ
Install Git
Install Docker
Install Docker Compose
https://www.docker.com/get-started
http://localhost:80