Skip to content

Simple React package development project example template.

License

Notifications You must be signed in to change notification settings

uiwjs/react-monorepo-template

Repository files navigation

react-monorepo-template

Buy me a coffee Build & Deploy Coverage Status

Simple React package development project example template.

Directory Structure

├── LICENSE
├── README.md -> core/README.md
├── core              # 📦 package @uiw/react-monorepo-template
│   ├── README.md
│   ├── cjs           # 🔄 Compiled cjs directory
│   ├── esm           # 🔄 Compiled esm directory
│   ├── src           # Package source directory
│   ├── dist.css      # 🔄 compile less to css
│   ├── package.json  # name => @uiw/react-monorepo-template
│   └── tsconfig.json
├── lerna.json
├── package.json
├── tsconfig.json
├── test              # ⛑ test case
└── website           # 🐝 Package example test, website
    ├── README.md
    ├── package.json
    ├── public
    ├── src
    └── tsconfig.json

Development

  1. Dependencies in the installation package and example
npm run install
  1. To develop, run the self-reloading build:
npm run build  # Compile packages      📦 @uiw/react-monorepo-template
npm run watch  # Real-time compilation 📦 @uiw/react-monorepo-template
  1. Run Document Website Environment:
npm run start
  1. To contribute, please fork repos, add your patch and tests for it (in the test/ folder) and submit a pull request.
npm run test

Using

import React from "react";
import MonorepoTemplate from '@uiw/react-monorepo-template';

export default function App() {
  return (
    <div className="container">
    <MonorepoTemplate>
      Example test
    </MonorepoTemplate>
    </div>
  );
}

Contributors

As always, thanks to our amazing contributors!

Made with contributors.

License

Licensed under the MIT License.