Skip to content

1. Installation

Jump to bottom
Aft edited this page May 22, 2024 · 8 revisions
  1. Download source code smartMoney 
git clone https://github.com/mrahmadt/smartMoney.git
cd smartMoney

  1. Follow Laravel Deployment for server requirements and server-configuration.

  2. Set Up Environment Configuration: Copy the example environment configuration to a new .env file:

cp .env.example .env
  1. Configure Environment Variables

Open the .env file and update the following essential settings:

a. Make sure you have created a database and a database user. Update the database credentials accordingly:

DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=sail
DB_PASSWORD=password

b. Firefly-III Integration Provide the URL and Personal token for your Firefly-III instance:

FIREFLYIII_URL=https://moneycontrol.com
FIREFLYIII_TOKEN=eyJ0eXAiOiJKV1QiLC.....

c. Configure Azure OpenAI (Optional) If using Azure OpenAI for SMS parsing and categorization, update the following settings: (I never tested it with OpenAI API, but it should work).

OPENAI_ENABLED=true
OPENAI_URL='https://AAAA.openai.azure.com/openai/deployments/VVVVV/chat/completions?api-version=2024-02-01'
OPENAI_TOKEN='3333333333'

d. Migrate Database Run the database migrations to set up the required tables:

php artisan migrate

e. Setup cron job: You need to add cron configuration entry to our server that runs the schedule:run command every minute.

* * * * * cd /path-to-your-smartMoney && php artisan schedule:run >> /dev/null 2>&1

f. create user account: From smartMoney directory, run the following command to create a user for you

php artisan app:createUser

And now you will be able to access the admin portal https://yourserver/admin, you still need to configure the features that you want from smartMoney, make sure to check the github wiki pages.

Clone this wiki locally