Skip to content

Downloading and configuring finance (agnostic docs)

Austin Kregel edited this page Feb 1, 2021 · 2 revisions

Downloading code

Windows

We need to open the program "Git Bash". (Click the start menu icon, then type "git bash", and press enter). A black window should pop up your name@computer-name MINGW63 ~

Click on the window, then type git clone https://github.com/austinkregel/finance, and press enter. That will download the code to a folder called finance, you can find the finance folder here C:\Users\YOUR USER NAME\finance.

Mac/Linux

Open a terminal, then type git clone https://github.com/austinkregel/finance, and press enter. That will download the code to a folder called finance.

Configuring the project (Environment variables)

In your finance folder, you'll find a file called .env.example copy that file and name it .env

Your APP_NAME will reflect what will be displayed in the top left of the website.

Your DB_* variables are related to the database that will be used to power account storage. (These are passed directly to Laravel, so please refer to to their documentation for what's "valid".

Your REDIS_* variables are related to the Redis service which is used for background job processing. (These are passed directly to Laravel, so please refer to to their documentation for what's "valid".

Your MAIL_* variables are related to how this app sends emails to you. By default we just log your mail to you logs.(These are passed directly to Laravel, so please refer to to their documentation for what's "valid".

The PLAID_* variables are what we need from the Plaid Dashboard. Copy the client id to PLAID_CLIENT_ID, your public key to PLAID_PUBLIC_KEY, and your "Development" secret to PLAID_SECRET.