Repository files navigation

Setting up boiler plates when starting new projects is tedious sometimes and I often found myself setting it up from scratch 🥱

Hence I made this starterkit following some of the best patterns and practices I learnt from some of the larger codebase and fantastic developers I've had a chance to work with 🙌

The main purpose of this repository is to provide a scalable "batteries included" full stack starterkit which follows good architecture patterns (might be opinionated) and code decoupling which becomes significant as the project grows or new developers are onboarded

• All in TypescriptBecause TypeScript is awesome, and types are important 😃

• GraphQL FirstThis starterkit is built with graphql first approach using theApollo platform

• Includes CICI is integral part of any project. This starterkit includesGithub Actions by default. PR's for integration with any other providers are welcome 🙌

• Docker SupportYou can also use docker to develop and run your applications

• Testing FocusedThis project usesJest for testing framework and comes with sample tests which are easy to extend

• PrismaPrisma is the ORM being used forPostgreSQL. Feel free to submit a PR for any other ORM or drivers you'd like to see here 😁

• PWA SupportThis starterkit comes with out of the box PWA support

Please leave a ⭐ as motivation if you liked the idea 😄

• Architecture
  • Backend
  • Web
• Getting started
• How to Contribute
• License

Here's a brief video overview of this project, hope it helps.

Big thanks to@mikestaub for mentoring me on the lot of the ideas you will come across in this repository. Checkout how he's changing social media withPeapods

Here is the folder structure forbackend, it is usingyarn workspaces which helps us split our monorepo into packages such as DB, GraphQL. Which if required can be made into their own micro services.

backend├── build├── config├── logs├── packages│   ├── db│   │   └──prisma│   ├── graphql│   │   ├── api│   │   ├── schema│   │   └── types│   └── utils├── tests│   ├── db│   └── graphql├── index.ts└── package.json

This workspace package contains the database abstractions. The database stack isPostgreSQL as relational database andPrisma as an ORM, read more about DB packagehere

The GraphQL package is organized as below:

graphql├── schema│   └── user                <---- some entity│       ├── resolvers │       │     ├── types     <---- type resolvers│       │     ├── queries   <---- query resolvers│       │     └── mutations <---- mutation resolvers│       ├── queries.graphql│       ├── mutations.graphql│       └── types.graphql├── api│   ├── queries             │   └── mutations├── types                   <---- graphql types│   ├── schema           │   └── resolvers└── index.json

The schema splits each entity into it's own set of schema to modularize the codebase. The graphql package usesschema stitching andcode generators to construct the whole schema.

It is organized so because if you choose to split graphql into it's own set of microservices later, it should be relatively easier to do so as this should be easy to integrate withApollo Federation

Read more about GraphQL packagehere

Here is the folder structure forweb, it is a standardcreate-react-app usingcraco to override configs without ejecting

Web package usesMaterial UI heavily as it makes theming and customization very easy. PR's for any other UI kit are welcome 😃

web├── build├── public├── src│   ├── assets│   ├── config│   ├── constants│   ├── global│   ├── tests│   ├── layout     <---- controls, pure components│   ├── theme      <---- theme config│   ├── graphql│   │   └── operations.tsx     <---- generated graphql operations and types│   ├── pages│   │   └──  Home   <---- page component│   │        ├── components <---- page specific components│   │        └── hooks      <---- page specific custom hooks   │   └── utils├── tests│   ├── db│   └── graphql├── index.ts└── package.json

Setting up environment variables

Before getting started, create.env files at bothbackend/.env as well asweb/.env following the.env.template files located in those directories.

Install dependencies

I recommend usingyarn instead ofnpm as this project heavily usesyarn workspaces

Installvolta, which should automatically install correctnode andyarn version when you checkout the repository (check the root package.json for config)

yarn

To install dependencies forweb andbackend automatically, a postinstall script has been added in the mainpackage.json

Running web

• Docker (recommended)

$ cd web$ yarn dev

Once you're done working, useyarn dev:down command to stop the docker containers.

• Locally

$ cd web$ yarn start:web

Running backend

• Docker (recommended)

$ cd backend$ yarn dev

Once the container starts, you'll be inside the backend image. Now, simply migrate the db (only first time) and start the development server.

$ yarn migrate$ yarn start

Once you're done working, exit out from the container and useyarn dev:down command to stop the docker containers.

• Locally

$ cd backend$ yarn start

Note: When running locally, you'll be required to run your own instance of postgres.

Running backend-go

If you don't havemake installed, commands are available inMakefile.

$ cd backend-go$ make dev

Now from inside the container, you can run the tests or application like below:

$ make test$ make run

Codegen

This starterkit usesgraphql-code-generator to codegen lot of things like TypeScript types, React Apollo hooks and queries, GraphQL Schema AST etc.

cd backendyarn generate:graphql

Contributions are welcome as always, before submitting a new PR please make sure to open a newissue so community members can discuss.

Additionally you might find existing open issues which can helps with improvements.

This project follows standardcode of conduct so that you can understand what actions will and will not be tolerated.

This project is MIT licensed, as found in theLICENSE

Built and maintained with 🌮 byKaran

💼 Hire Me |🍺 Donate