Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sethmcleod/next-app
⚡️ Type-safe Next.js and GraphQL boilerplate
https://github.com/sethmcleod/next-app
chakra-ui graphql nextjs typescript
Last synced: about 15 hours ago
JSON representation
⚡️ Type-safe Next.js and GraphQL boilerplate
- Host: GitHub
- URL: https://github.com/sethmcleod/next-app
- Owner: sethmcleod
- License: mit
- Created: 2020-01-28T15:06:20.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-03T20:33:38.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T23:56:57.288Z (over 1 year ago)
- Topics: chakra-ui, graphql, nextjs, typescript
- Language: TypeScript
- Homepage:
- Size: 3.03 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚡️ Next App
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.
Here are some of the technologies used:
- [Next.js](https://nextjs.org/) as the React framework
- [TypeScript](https://www.typescriptlang.org/) as the programming language
- [Chakra UI](https://chakra-ui.com/) as the React component library
- [urql](https://github.com/formidablelabs/urql) as the GraphQL client
- [Nexus](https://nexusjs.org/) for constructing the GraphQL schema
- [Prisma](https://www.prisma.io/) as the ORM for managing the database and migrations
- [PostgreSQL](https://www.postgresql.org/) as the database
- [Vercel](https://vercel.com/) for deployments and infrastructure
- [Stripe](https://stripe.com) for handling subscriptions and payments
- [Postmark](https://postmarkapp.com) as the email API
## Getting started
### Initial setup
Copy `.env.example` to `.env` and fill out the `.env` file with your environment variables!
```sh
cp .env.example .env
```
Now you're ready to set everything up locally:
1. **Install Docker** by following their [installation instructions for your OS](https://docs.docker.com/get-docker/). This is used for the local development database.
2. **Switch to the correct Node version** with `nvm`:
```sh
nvm use
```
3. **Install the dependencies** with `yarn`:
```sh
yarn
```
4. **Start the local development database** as well as the Stripe CLI webhook listener with `docker compose`:
```sh
docker compose up
```
5. **Copy the webhook signing secret** that the Stripe CLI logged and add it to your `.env` file.
6. **Migrate your local development database** to the base schema:
```sh
yarn prisma:migrate
```
### Development workflow
To develop your app, you always need to have two commands running concurrently:
1. **Start the development database** with:
```sh
docker compose up
```
2. **Start the development process**, which also runs all the necessary code generators:
```sh
yarn dev
```
That's it! Now you can visit http://localhost:3000 🎉
#### Scripts
The **three most important commands** you'll run frequently during development:
- `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.
- `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.
- `yarn prisma:studio`: Starts [Prisma Studio](https://prisma.io/studio) on `localhost:5555` where you can inspect your local development database.
- `yarn cypress:open`: Opens Cypress so you can write and run your end-to-end tests. ([docs](https://docs.cypress.io/guides/getting-started/installing-cypress.html#Adding-npm-scripts))
All the others are used in CI or by those three main scripts, but you should only rarely need to run them manually.
---
Crafted with ❤️ and 🍺
Inspired by [Bedrock](https://bedrock.mxstbr.com/) by [Max Stoiber](https://mxstbr.com/)