GithubHelp home page GithubHelp logo

React Starter Kit

The web's most popular Jamstack front-end template for building web applications with React.

Features

  • Optimized for serverless deployment to CDN edge locations (Cloudflare Workers)
  • HTML page rendering (SSR) at CDN edge locations, all ~100 points on Lighthouse
  • Hot module replacement during local development using React Refetch
  • Pre-configured with CSS-in-JS styling using Emotion.js
  • Pre-configured with code quality tools: ESLint, Prettier, TypeScript, Vitest, etc.
  • Pre-configured with VSCode code snippets and other VSCode settings
  • The ongoing design and development is supported by these wonderful companies:

Β Β Β Β 


This project was bootstrapped with React Starter Kit. Be sure to join our Discord channel for assistance.

Directory Structure

β”œβ”€β”€.github β€” GitHub configuration including CI/CD workflows
β”œβ”€β”€.vscode β€” VSCode settings including code snippets, recommended extensions etc.
β”œβ”€β”€app β€” Web application front-end built with React and Material UI
β”œβ”€β”€edge β€” Cloudflare Workers (CDN) edge endpoint
β”œβ”€β”€env β€” Application settings, API keys, etc.
β”œβ”€β”€scripts β€” Automation scripts such as yarn deploy
β”œβ”€β”€tsconfig.base.json β€” The common/shared TypeScript configuration
└──tsconfig.json β€” The root TypeScript configuration

Tech Stack

Requirements

Getting Started

Generate a new project from this template, clone it, install project dependencies, update the environment variables found in env/*.env, and start hacking:

$ git clone https://github.com/kriasoft/react-starter-kit.git example
$ cd ./example
$ yarn install
$ yarn start

The app will become available at http://localhost:5173/ (press q key to exit).

IMPORTANT: Ensure that VSCode is using the workspace version of TypeScript and ESLint.

Scripts

  • yarn start β€” Launches the app in development mode on http://localhost:5173/
  • yarn build β€” Compiles and bundles the app for deployment
  • yarn lint β€” Validate the code using ESLint
  • yarn tsc β€” Validate the code using TypeScript compiler
  • yarn test β€” Run unit tests with Vitest, Supertest
  • yarn edge deploy β€” Deploys the app to Cloudflare

How to Deploy

Ensure that all the environment variables for the target deployment environment (test, prod) found in /env/*.env files are up-to-date.

If you haven't done it already, push any secret values you may need to CF Workers environment by running yarn workspace edge wrangler secret put <NAME> [--env #0].

Finally build and deploy the app by running:

$ yarn build
$ yarn deploy [--env #0] [--version #0]

Where --env argument is the target deployment area, e.g. yarn deploy --env=prod.

How to Update

  • yarn set version latest β€” Bump Yarn to the latest version
  • yarn upgrade-interactive β€” Update Node.js modules (dependencies)
  • yarn dlx @yarnpkg/sdks vscode β€” Update TypeScript, ESLint, and Prettier settings in VSCode

Contributors πŸ‘¨β€πŸ’»

Β Β Β Β Β Β Β Β Β Β Β Β Β Β 

Backers πŸ’°

Β Β Β Β Β Β Β Β Β Β Β Β Β Β 

Related Projects

How to Contribute

Anyone and everyone is welcome to contribute. Start by checking out the list of open issues marked help wanted. However, if you decide to get involved, please take a moment to review the guidelines.

License

Copyright Β© 2014-present Kriasoft. This source code is licensed under the MIT license found in the LICENSE file.


Made with β™₯ by Konstantin Tarkus (@koistya, blog) and contributors.

Rafi Rahman Raif's Projects

react-starter-kit icon react-starter-kit

The web's most popular Jamstack front-end template (boilerplate) for building web applications with React

theme icon theme

ζ”Άι›†ηš„bootstrapδΈ»ι’˜ι‘΅ι’οΌŒε‰ε°ιƒ½ζœ‰οΌŒζ¬’θΏŽδ½Ώη”¨

tools icon tools

Codelabs management & hosting tools

truecallerapi icon truecallerapi

πŸ“˜ OpenAPI/Swagger-generated API Reference Documentation

ublock icon ublock

uBlock Origin - An efficient blocker for Chromium and Firefox. Fast and lean.

unblocker icon unblocker

Makes region-restricted websites accessible

wpt icon wpt

Test suites for Web platform specs β€” including WHATWG, W3C, and others

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.