/insights

React application that uses the YNAB API to get more data insights into spending

Primary LanguageTypeScriptMIT LicenseMIT

Insights README

Project Tooling

Front-end

react
typescript
material-ui
dx-react-grid
moment

Up for removal

Redux React

Backend Tooling

MongoDB Compass
express
overnightjs

How to run

Running the UI

See yarn start down below

Running the Server

  • You will need to create folder called 'data' in the root directory
  • Add a file to 'data' called user-config.js which looks something like
exports.userConfigToken = '<YOUR TOKEN HERE>';

  • You can find how to get a token from here

  • You will also need to have a MongoDB instance running somewhere. I used MongoDB Compass to visualize it all.

  • I created a database called ynab and inside of that database I created the following collections

    • budgets
    • categories
    • accounts
    • payees
    • transactions

  • Once you have this created you can go to the admin page and using your token it will sync down your data and store it in Mongo

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode and using concurrently it will live reload the server/UI.
This will open localhost:3000 in the browser.
Also spins up the Express Server at localhost:5000

The page will reload if you make edits.
You will also see any lint errors in the console.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.