Transaction Exporter For YNAB

Configurable transaction export tool for YNAB online budgeting tool.

Bug Reports • Feature Requests

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

This project aims to make exporting transaction data easier by allowing users to save a "template" of export settings to be reused for future exports.

I wanted to build a webapp using the latest versions of Laravel, Vue.js and Alpine.js to experiment with the new tech. I really enjoy building using the Test Driven Development (TDD) methodology, but rarely have the opportunity on client projects.

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Since the project is based on Laravel 10.x, you'll need to have at least PHP version 8.1 installed. We also assume you have Composer installed globally on your OS.

PHP can be set up locally on your OS or install Laravel Sail for an all-in-one local development solution.

Installation

1. Create a Personal Access Token on the Developer Settings page in YNAB. Check out the YNAB documentation for more information on getting your personal access token.

2. Clone the repo to your local machine.

git clone https://github.com/incredimike/exporter-for-ynab.git

3. Create a new .env file by copying the .env.example file shipped in the repo.

cp .env.example .env

4. Add your YNAB Developer API key to the .env file

YNAB_API_TOKEN=<YOUR_TOKEN_HERE>

5. Install PHP Composer packages

composer install

6. If using Laravel Sail, you will want to run the application locally with the following command:

sail up -d

Usage

TBD

Testing

You can run PHPUnit tests locally using the phpunit binary installed with composer:

vendor/bin/phpunit

Or you can run tests using the Sail docker containers:

sail test

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing features, feel free to open an issue to discuss it, or directly create a pull request.
• Create individual PR for each feature suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some Amazing Feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Mike Walker - Full-Stack Web Developer - https://incredimike.com

Acknowledgements

• YNAB - YNAB is short for "You Need A Budget", an amazing online budgeting & financial management software system.
• ImgShields - ImgShields provide the images at the top of the README.