Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Shpigford committed Jan 11, 2024
1 parent 8bce278 commit 6bcab0f
Showing 1 changed file with 3 additions and 70 deletions.
73 changes: 3 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

0 comments on commit 6bcab0f

Please sign in to comment.