generated from react18-tools/turborepo-template
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from mayank1513/touchup
Touchup
- Loading branch information
Showing
9 changed files
with
98 additions
and
131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +0,0 @@ | ||
| # @mayank1513/fork-me | ||
|
|
||
| ## 2.0.1 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Add provenance | ||
|
|
||
| ## 2.0.0 | ||
|
|
||
| ### Major Changes | ||
|
|
||
| - Support Next.js 14 | ||
|
|
||
| ## 1.1.2 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Add z-index to make sure ribbon is not covered | ||
|
|
||
| ## 1.1.1 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Fix CSS modules | ||
|
|
||
| ## 1.1.0 | ||
|
|
||
| ### Minor Changes | ||
|
|
||
| - Added new prop shadowColor - drop shadow on hover defaults to bgColor | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,84 @@ | ||
| # Fork Me React.js component | ||
| # React18GlobalStore | ||
|
|
||
| A simple fork me component for React.js projects! | ||
| [](https://github.com/react18-tools/r18gs/actions/workflows/test.yml) [](https://codeclimate.com/github/react18-tools/r18gs/maintainability) [](https://codecov.io/gh/react18-tools/r18gs) [](https://www.npmjs.com/package/r18gs) [](https://www.npmjs.com/package/r18gs)  [](https://gitpod.io/from-referrer/) | ||
|
|
||
| ## Motivation | ||
|
|
||
| I have built wonderful libraries utilizing React18 features using Zustand. They worked awesome. However, when I try importing from specific folder for better tree-shaking, the libraries fail. This is because, for each import a separate zustand store is created. This actually increases the package size also. | ||
|
|
||
| Thus, I decided to create a bare minimum, ultra-light store that creates shared state even while importing components from separate files for better treeshaking. | ||
|
|
||
| > Will be using this library soon to fix issues with `nextjs-themes`. | ||
| ## Features | ||
|
|
||
| ✅ Full TypeScript Support | ||
|
|
||
| ✅ Unleash the full power of React18 Server components | ||
|
|
||
| ✅ Works with all build systems/tools/frameworks for React18 | ||
|
|
||
| ✅ Doccumented with [Typedoc](https://react18-tools.github.io/r18gs) ([Docs](https://react18-tools.github.io/r18gs)) | ||
|
|
||
| ✅ Next.js, Vite and Remix examples | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| $ pnpm add @mayank1513/fork-me | ||
| # or | ||
| $ npm install @mayank1513/fork-me | ||
| # or | ||
| $ yarn add @mayank1513/fork-me | ||
| $ pnpm add r18gs | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ```bash | ||
| $ npm install r18gs | ||
| ``` | ||
|
|
||
| ## Add on your page | ||
| or | ||
|
|
||
| ```ts | ||
| <ForkMe gitHubUrl="https://github.com/mayank1513/turborepo-template" /> | ||
| // and | ||
| <StarMe gitHubUrl="https://github.com/mayank1513/turborepo-template" /> | ||
| ```bash | ||
| $ yarn add r18gs | ||
| ``` | ||
|
|
||
| You need to import styles for ForkMe component | ||
| ### Build | ||
|
|
||
| To build all apps and packages, run the following command: | ||
|
|
||
| ```ts | ||
| import "@mayank1513/fork-me/server/index.css"; | ||
| ``` | ||
| cd r18gs | ||
| pnpm build | ||
| ``` | ||
|
|
||
| ### Develop | ||
|
|
||
| ## Optional parameters | ||
| To develop all apps and packages, run the following command: | ||
|
|
||
| ```ts | ||
| text?: string; // replace the Fork me on GitHub text | ||
| width?: string | number; // if you need to adjust the width of the ribbon (length) | ||
| height?: string | number; // to adjust height of the ribbon | ||
| bgColor?: string; // background color | ||
| textColor?: string; // text color | ||
| ``` | ||
| cd r18gs | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| ## Useful Links | ||
|
|
||
| Learn more about the power of Turborepo: | ||
|
|
||
| - [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) | ||
| - [Caching](https://turbo.build/repo/docs/core-concepts/caching) | ||
| - [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) | ||
| - [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) | ||
| - [Configuration Options](https://turbo.build/repo/docs/reference/configuration) | ||
| - [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) | ||
|
|
||
| ### 🤩 Don't forger to start [this repo](https://github.com/mayank1513/r18gs)! | ||
|
|
||
| Want hands-on course for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React and TypeScrypt](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescrypt/?referralCode=851A28F10B254A8523FE) | ||
|
|
||
|  | ||
|
|
||
| ## License | ||
|
|
||
| Licensed as MIT open source. | ||
|
|
||
| <hr /> | ||
|
|
||
| > This package also serves as an example to demonstrate how to build and publish `React.js` library compatible with React Server Components | ||
| <p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters