1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-08-08 23:15:24 +02:00

Update README.md

Signed-off-by: Josh Pigford <josh@joshpigford.com>
This commit is contained in:
Josh Pigford 2024-01-10 10:59:40 -06:00 committed by GitHub
parent 8cf027cb92
commit 9e8ad317ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,4 +1,8 @@
# 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.
@ -6,8 +10,6 @@ The README below was what we used internally, so many of the links won't work an
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.