Code Monkey home page Code Monkey logo

vr_frontend's Introduction

Monorepo frontend boilerplate

Commitzen friendly Conventional Commits

Getting started

This is a monorepo repository using yarn workspaces, Commitzen and Conventional Commits to maintain and manage component versions and for documentation, we use Storybook.

๐Ÿ’ฅ Features

  • โšก๏ธ Vite 2.0 - (React 18)
  • ๐Ÿ“– Storybook 6
  • ๐Ÿ“ฆ Yarn Workspaces
  • โœจ Host Multiple CRA Apps, Vite apps, Component Libraries & Storybooks in one monorepo
  • ๐Ÿ”ฅ Hot Reload all Apps, Components & Storybooks
  • ๐Ÿ‘จโ€๐Ÿ”ฌ Test all workspaces with Eslint & Jest using one command

๐ŸŒ Samples

Spotifood

Code: https://github.com/emunhoz/spotifood

Find movies

Code: https://github.com/emunhoz/find-movies

๐ŸŒ Links

Storybook live demo:

Storybook

Vite App live demo:

Backend server:

โš ๏ธ Requirements

  • Node > v18
  • NPM > v8

In order to use semantic release with github actions, you need to add a new secrets in your github repository. This is needed in order for Semantic Release to be able to publish a new release for the Github repository.

Create a token for Github. You need to give the token repo scope permissions.

Check out this file: https://github.com/emunhoz/monorepo-boilerplate/blob/main/.github/workflows/release.yml#L32

You need to change this value with you new secrets: GH_MONOREPO_TOKEN

๐Ÿš€ Quick start

In the root folder run following commands (all the below commands need to run on root folder):

Install all dependecies with:

  yarn

Run the front end application @monorepo-boilerplate/web and back end server application @monorepo-boilerplate/server :

  yarn start

Storybook @monorepo-boilerplate/ui-components :

  yarn storybook

๐Ÿ—‚ Monorepo structure

Package Description
@monorepo-boilerplate/design-tokens Design tokens (colors, typography, attributes...)
@common/** Common functions, images, lints (eslint, stylelint, prettier) and other generics setup
@monorepo-boilerplate/ui-components React library components with stories
@monorepo-boilerplate/web Front end application create with vite app

๐Ÿšจ Code standard

โŒจ๏ธ Commands

Command Description
yarn Install all dependencies
yarn start Run frontend/backend server
yarn test:ci Run all tests
yarn storybook Run storybook doc components
yarn watch:tokens Hot reload design-tokens package
yarn watch:components Hot reload ui-components package
yarn build-app Build of front app(@monorepo-boilerplate/web) and generate a directory with all assets in the following path: packages/web/build
yarn build-storybook Build of storybook with components(@monorepo-boilerplate/ui-components) and generate a directory with all assets in the following path: packages/ui-components/storybook-static

vr_frontend's People

Contributors

rossixiluo avatar

Watchers

 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.