Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cover image to readme #20

Merged
merged 3 commits into from
Dec 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 22 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![Screenshot of the app and the SST multiplex in the terminal](./.github/cover.png)

# The Startup Stack

Get independence from expensive SaaS without loosing its developer experience,
@@ -27,6 +29,7 @@ delightful, secure user experiences.
- **[Drizzle ORM][]** as the headless TypeScript ORM.
- **[Stripe][]** for subscription plans, customer portal, and more.
- **[Bun][]** for fast local development.
- **[Biome][]** for fast linting and formatting.
- **[shadcn][]** React components.
- **[Tailwind CSS][]** utility CSS Framework.
- **[React Email][]**, customizable emails with React.
@@ -176,6 +179,18 @@ This template is not designed to be the quickest to set up to play with.
- Checkout the repository.
- `bun install` to install the dependencies.

### AWS

SST requires an [AWS][] account.

The easiest way is to use your personal root user account to try things out. If
you are going to run this stack under an AWS Organization, checkout the SST docs
on how to [setup your AWS account](https://sst.dev/docs/aws-accounts).

When you’re done, read the
[SST credentials docs](https://sst.dev/docs/iam-credentials) and put your
credentials in `~/.aws/credentials`.

### Domain

A domain registered with
@@ -206,18 +221,6 @@ Just kicking the tires? You can skip this setting up a domain for now.
- },
```

### AWS

SST requires an [AWS][] account.

The easiest way is to use your personal root user account to try things out. If
you are going to run this stack under an AWS Organization, checkout the SST docs
on how to [setup your AWS account](https://sst.dev/docs/aws-accounts).

When you’re done, read the
[SST credentials docs](https://sst.dev/docs/iam-credentials) and put your
credentials in `~/.aws/credentials`.

### Neon

1. Get an account on [Neon](https://neon.tech) and create a Postgres database.
@@ -236,6 +239,12 @@ bun run db:push
bun run db:seed
```

Whenever you make changes to the database schema you should run:

```sh
bun run db:migrate
```

### Stripe

In order to use Stripe Subscriptions and seed our database, we need to get the
@@ -366,3 +375,4 @@ Usage is as simple as it can be, as everything is already set up for you.
[Zod]: https://zod.dev
[AWS]: https://aws.amazon.com
[Bun]: https://bun.sh
[Biome]: https://biomejs.dev