Skip to content

Commit 25ae268

Browse files
committed
Update README.md
1 parent 34b5a7a commit 25ae268

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
# Next App
1+
# ⚡️ Next App
22

3-
⚡️ Next.js & GraphQL boilerplate
3+
Next App is a full-stack, type-safe boilerplate for building SaaS apps. It includes everything you need to hit the ground running on a new project.
44

5-
- [Stripe](https://stripe.com) is used for payments
6-
- [Postmark](https://postmarkapp.com) is used for sending emails
5+
Here are some of the technologies used:
6+
7+
- [Next.js](https://nextjs.org/) as the React framework
8+
- [TypeScript](https://www.typescriptlang.org/) as the programming language
9+
- [Chakra UI](https://chakra-ui.com/) as the React component library
10+
- [urql](https://github.com/formidablelabs/urql) as the GraphQL client
11+
- [Nexus](https://nexusjs.org/) for constructing the GraphQL schema
12+
- [Prisma](https://www.prisma.io/) as the ORM for managing the database and migrations
13+
- [PostgreSQL](https://www.postgresql.org/) as the database
14+
- [Vercel](https://vercel.com/) for deployments and infrastructure
15+
- [Stripe](https://stripe.com) for handling subscriptions and payments
16+
- [Postmark](https://postmarkapp.com) as the email API
717

818
## Getting started
919

@@ -42,7 +52,7 @@ docker compose up
4252
6. **Migrate your local development database** to the base schema:
4353

4454
```sh
45-
yarn migrate
55+
yarn prisma:migrate
4656
```
4757

4858
### Development workflow
@@ -69,7 +79,7 @@ The **three most important commands** you'll run frequently during development:
6979

7080
- `yarn generate`: Generates the Prisma client ([docs](https://www.prisma.io/docs/concepts/components/prisma-client)), which Nexus uses and generates the GraphQL schema ([docs](https://nexusjs.org/docs/guides/generated-artifacts)), which GraphQL Codegen uses and generates the urql hooks ([docs](https://graphql-code-generator.com/docs/plugins/typescript-urql)). Run this whenever you change the database schema, GraphQL schema or GraphQL queries.
7181

72-
- `yarn migrate`: Creates migration files from your Prisma schema changes and runs those migrations on your local dev db ([docs](https://www.prisma.io/docs/concepts/components/prisma-migrate)). Run this whenever you change your database schema.
82+
- `yarn prisma:migrate`: Creates migration files from your Prisma schema changes and runs those migrations on your local dev db ([docs](https://www.prisma.io/docs/concepts/components/prisma-migrate)). Run this whenever you change your database schema.
7383

7484
- `yarn prisma:studio`: Starts [Prisma Studio](https://prisma.io/studio) on `localhost:5555` where you can inspect your local development database.
7585

0 commit comments

Comments
 (0)