Skip to content

Commit

Permalink
remove gitbook & update readme to base dir
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewwong525 committed Mar 3, 2024
1 parent 255fe8e commit 37cd49b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 15 deletions.
22 changes: 10 additions & 12 deletions docs/README.md → README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# README

## Flutter / Supabase Production Template for Startups
# Flutter / Supabase Production Template for Startups

**Demo**: [https://app.devtodollars.com](https://app.devtodollars.com)

**Documentation:** [See Pricing](./#pricing)

***

### About Me
## About Me

I'm Matt, the creator of this boilerplate and a former YC founder. Throughout my journey, I went from $0 - $10k of revenue 2 separate times. Before my third time I wanted to create a startup template for building apps (Flutter / Supabase) to expedite this process. I figured that this template could help a lot of other people as well so I decided to clean it up and share it with the world!

[Follow me on twitter](https://twitter.com/IThinkWong)

***

### Pricing
## Pricing

I open sourced the code but decided to close source the detailed documentation. You could either **spend 20+ hours** piecing together documentation from separate websites or support me and purchase detailed guides to get you up and running as fast as possible.

Expand All @@ -31,9 +29,9 @@ I open sourced the code but decided to close source the detailed documentation.

***

### What's Included:
## What's Included:

#### Frontend ([Flutter](https://flutter.dev/))
### Frontend ([Flutter](https://flutter.dev/))

* State Management ([riverpod](https://pub.dev/packages/riverpod))
* Routing ([go\_router](https://pub.dev/packages/go\_router))
Expand All @@ -43,15 +41,15 @@ I open sourced the code but decided to close source the detailed documentation.
* home\_screen
* 🚧 frontend tests 🚧

#### Backend ([Supabase](https://supabase.com/))
### Backend ([Supabase](https://supabase.com/))

* Authentication
* Email + PW
* 🚧 SSO (Google, Github, Apple, etc.) 🚧
* Fully configured for local development from day one
* 🚧 backend tests 🚧

#### Analytics ([Posthog](https://posthog.com/))
### Analytics ([Posthog](https://posthog.com/))

* Unified analytics across frontend and backend based on `user_id`
* Frontend analytics comes pre-installed for iOS, Android, Web, and MacOS
Expand All @@ -64,20 +62,20 @@ I open sourced the code but decided to close source the detailed documentation.
* `user opens billing portal`
* `user completes checkout`

#### Payments ([Stripe](https://stripe.com/en-ca))
### Payments ([Stripe](https://stripe.com/en-ca))

* Stripe fully setup and works with one-time payments and subscriptions
* `stripe` table to store `stripe_customer_id` and current `active_products`
* Stripe webhook to sync user subscriptions from stripe to supabase
* Deno function to retrieve the billing portal url or a checkout session url which works with the `payments_screen`

#### Release Pipelines ([Github Actions](https://github.com/features/actions))
### Release Pipelines ([Github Actions](https://github.com/features/actions))

* Script to `bumpversion.sh` following semantic versioning
* Deploys a web preview on Netlify for every PR
* Publishing pipeline to publish to Netlify and to publish supabase functions
* 🚧 Workflow to create signed releases for Android and iOS 🚧

#### 🚧 Error Monitoring ([Sentry](https://sentry.io/welcome/)) 🚧
### 🚧 Error Monitoring ([Sentry](https://sentry.io/welcome/)) 🚧

TODO: based on demand.
3 changes: 0 additions & 3 deletions docs/SUMMARY.md

This file was deleted.

0 comments on commit 37cd49b

Please sign in to comment.