Giter VIP home page Giter VIP logo

boilerplate's Introduction

Boilerplate

Built by No Quarter


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


Feel comfortable with this stack?

We are hiring! Contact us here


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

We use AWS S3 for image/file hosting, so you'll need to set up a few things for this to work, process can be found here.



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


boilerplate's People

Contributors

renovate-bot avatar jclackett avatar renovate[bot] avatar dependabot[bot] avatar rykuno avatar lewisblackburn avatar

Stargazers

Roman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.