Skip to content

canopas/fullstack-graphql-react-starter-kit

Repository files navigation

Boilerplate with GraphQL, ReactJS, NodeJS, and MySQL

This boilerplate project provides a solid foundation for developing web applications using GraphQL, ReactJS, NodeJS, and MySQL. With its intuitive architecture and powerful technologies, this project template empowers developers to quickly build scalable and efficient applications.

This includes essential configurations, common components, and best practices to help you kickstart your development process. Whether you're a beginner or an experienced developer, this project template is designed to accelerate your workflow and enable you to focus on building innovative features.

Project structure

The project has 4 sub-projects to handle all the functionalities of the project.

Requirements

  • Node v20.3.1
  • Typescript

Install dependencies

  • Install dependencies

    yarn install
    
  • Add new dependency

    yarn add <dependency name>
    

Run the server

Node Backend

  • Start Node Server

    yarn start
    
  • Run test

    yarn test
    

    You should find GraphQL API running at http://localhost:4000/graphql.

React Frontend, React admin and Business dashboard

  • go to the choosen directory using below command,

    cd <directory-name>
    
  • Build project

    yarn build
    
  • Start development Server

    yarn dev
    

    Server will start at http://localhost:<port>.

To enable pre-commit hook

git config core.hooksPath .githooks

API documentation

  • Find full API documentation here.

Dependencies

Backend

Frontend

Test

LICENSE

This repository is released under the MIT.