Docker/Maybe
Docker/Maybe
1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-08-08 23:15:24 +02:00
Code Issues Releases Activity Actions

Readme update

Browse source
This commit is contained in:
Josh Pigford 2024-01-11 13:18:06 -06:00
parent 8bce278354
commit 6bcab0fd05
1 changed files with 3 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -2,9 +2,9 @@
# 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>
<b>Get involved: [Discord](https://link.maybe.co/discord) • [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.
🚨 NOTE: This is the original React app of the previously-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.
There's a LOT of work to do to get this functioning, but it should be feasible.
@ -48,73 +48,6 @@ You can view the current [high-priority issues here](https://github.com/maybe-fi
- [Learn about how the app is organized as a monorepo](https://github.com/maybe-finance/maybe/wiki/Monorepo-File-Structure-Overview)
## Credit
## Credits
The original app was built by [Zach Gollwitzer](https://twitter.com/zg_dev), [Nick Arciero](https://www.narciero.com/) and [Tim Wilson](https://twitter.com/actualTimWilson), with design work by [Justin Farrugia](https://twitter.com/justinmfarrugia). The app is currently maintained by [Josh Pigford](https://twitter.com/Shpigford).
---
## ⚠️ Everything below is archived from the original repo and we're slowly working to replace/update it.
# Quick Start
## System Prerequisites
- Docker (if not using Docker, you will need Node LTS 14.7.x and Postgres 13.x)
- (Optional, highly recommended) - Install the [NX Console](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console) for [using the nx client](#nrwl-nx-overview)
## Run the app locally
### Setup ENV
```
cp .env.example .env
```
A working local development `.env` file can be found in 1Password under the "Engineering" folder.
### With Docker (preferred)
#### Start server and client apps
```
yarn install # re-run if it hangs
yarn dev
```
#### Start Postgres & Redis Services
```
yarn run dev:services
```
#### Migrate DB
In a separate terminal, run the following command. This will connect to the Postgres DB running inside Docker and run all the migrations in `/prisma/migrations`.
```
yarn prisma:migrate:dev
```
You will also want to seed the database (includes account types and subtypes for categorization).
```
yarn prisma:seed
```
### Manually
_NOTE: Make sure Postgres 13.x is running on your machine_
```
yarn install
nx serve client # Terminal 1
nx serve server # Terminal 2
yarn prisma:migrate && yarn prisma:seed # Terminal 3 - after apps are running
```
# Reference
## Authentication
[See this wiki page](https://github.com/maybe-finance/maybe/wiki/Auth0) for an explanation of how authentication/authorization works in this codebase.