开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

Boilerplate

Typescript + React + React Native + GraphQL + Prisma

Comes with user authentication included

• React
• React Native
• Expo
• TypeGraphQL
• Prisma
• Web, App & API monorepo
• Next.js
• TypeScript
• Postgres
• Apollo Client
• Apollo Server
• Express
• React hook form
• Chakra UI
• Customizable theme & Dark mode
• Eslint
• Prettier
• Graphql Code Generator
• Sendgrid SMTP
• Sentry
• Husky
• Lint staged

& many more tasty treats

Get Started

You must have node, yarn, postgres and redis installed and setup locally

1. Clone the repo

2. Delete the app folder if you're working on a purely web project.

   rm -rf packages/app

3. Install dependencies.

   yarn install

4. Create local postgres database

   createdb boilerplate

5. Create a .env file and update the DATABASE_URL with your local postgres database url.

   cp packages/api/.env.example  packages/api/.env

   # Replace <user>,<password> and <db-name> with your corresponding username, password, and database name of your postgresql database.
   DATABASE_URL=postgresql://<user>:<password>@localhost:5432/<db-name>

6. Migrate the database.

   cd packages/api && yarn db:migrate

We use Husky to run a couple of checks each commit (prettier, eslint & commitlint), make sure to add a .huskyrc file to your home directory:

touch ~/.huskyrc

and copy this into the file this in:

export PATH="/usr/local/bin:$PATH"

then run this in the root of the project:

npx husky install

Development

1. cd packages/api && yarn dev
2. cd packages/web && yarn dev
3. cd packages/app && yarn start

An example of creating a simple todo feature can be found here.

Production

Mailers

• Create a Sendgrid account and set a SENDGRID_API_KEY environment variable in .env
• Create templates for each email you want to send and use the templateId in the corresponding mailer class

Error tracing

• Create a Sentry account + project for each package and add the DSN to the web config and the api env variables

Deployment

An example is deployed here

We are using Heroku for the API package and Vercel for the WEB package