Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Josh Pigford <[email protected]>
  • Loading branch information
Shpigford authored Jan 10, 2024
1 parent 8cf027c commit 9e8ad31
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Maybe: An open-source personal finance app
![](https://github.com/maybe-finance/maybe/assets/35243/79d97b31-7fad-4031-9e83-5005bc1d7fd0)

# Maybe: Open-source personal finance app

<b>Get involved: [Discord](https://discord.gg/xfysSaSsfN)[Website](https://maybe.co)[Issues](https://github.com/maybe-finance/maybe/issues)</b>

🚨 NOTE: This is the original React/Next.js app of the now-defunct personal finance app, Maybe. This original version used many external services (Plaid, Finicity, Auth0, etc) and getting it to fully function will be a decent amount of work.

The README below was what we used internally, so many of the links won't work and the instructions won't necessarily be applicable.

There's a LOT of work to do to get this functioning, but it should be feasible.

The best way to get involved is on [Discord](https://discord.gg/xfysSaSsfN) and in the [Issues](https://github.com/maybe-finance/maybe/issues).

## Monorepo File Structure Overview

This repository uses the monorepo management tools from NRWL called `nx`. The NX dev tools come with pre-configured TS, ESLint, Prettier, Jest, Cypress and more, and provide an extensive suite of commands to lint, test, serve, and build applications. [Here's a great 10 minute video](https://nx.dev/l/r/getting-started/intro#10-minute-nx-overview) that walks through what nx can do.
Expand Down

0 comments on commit 9e8ad31

Please sign in to comment.