Skip to content

Commit

Permalink
Merge pull request #1 from mayank1513/setup-repo
Browse files Browse the repository at this point in the history
Merge to Set up this Repo
  • Loading branch information
mayank1513 authored Sep 1, 2023
2 parents 29f615d + b39a93c commit f44774b
Show file tree
Hide file tree
Showing 28 changed files with 23 additions and 95 deletions.
40 changes: 0 additions & 40 deletions .github/workflows/setup.yml

This file was deleted.

20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# Turborepo template [![test](https://github.com/mayank1513/turborepo-template/actions/workflows/test.yml/badge.svg)](https://github.com/mayank1513/turborepo-template/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/mayank1513/turborepo-template/graph/badge.svg?token=8LX1NLNVRV)](https://codecov.io/gh/mayank1513/turborepo-template) [![Version](https://img.shields.io/npm/v/@mayank1513/fork-me.svg?colorB=green)](https://www.npmjs.com/package/@mayank1513/fork-me) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/@mayank1513/fork-me.svg)](https://www.npmjs.com/package/@mayank1513/fork-me) [![Unit Tests](https://github.com/mayank1513/turborepo-template/actions/workflows/test.yml/badge.svg)](https://github.com/mayank1513/turborepo-template/actions/workflows/test.yml) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@mayank1513/fork-me)
# Turborepo template [![test](https://github.com/mayank1513/react18-themes/actions/workflows/test.yml/badge.svg)](https://github.com/mayank1513/react18-themes/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/mayank1513/react18-themes/graph/badge.svg?token=8LX1NLNVRV)](https://codecov.io/gh/mayank1513/react18-themes) [![Version](https://img.shields.io/npm/v/react18-themes.svg?colorB=green)](https://www.npmjs.com/package/react18-themes) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/react18-themes.svg)](https://www.npmjs.com/package/react18-themes) [![Unit Tests](https://github.com/mayank1513/react18-themes/actions/workflows/test.yml/badge.svg)](https://github.com/mayank1513/react18-themes/actions/workflows/test.yml) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react18-themes)

- ✅ Fully Treeshakable (`import from @mayank1513/fork-me/client/component`)
- ✅ Fully Treeshakable (`import from react18-themes/client/component`)
- ✅ Full TypeScript Support
- ✅ Unleash the full power of React18 Server components
- ✅ Works with all build systems/tools/frameworks for React18

This is a template created based on official starter Turborepo.
## Install

```bash
$ pnpm add @react18-themes
# or
$ npm install @react18-themes
# or
$ yarn add @react18-themes
```

> A quick tip: Delete all stale branches `git branch --merged main | grep -v '^[ *]*main$' | xargs git branch -d`
Simply click on `Use this template` button to use and customize this template for your next JavaSctipt / TypeScript / React / Vue / Next.js library or project.


## What's different from scaffolding turbo-repo by `create-turbo`

Expand Down Expand Up @@ -42,8 +50,8 @@ Following features make it really cool and useful
- [ ] Add `NPM_AUTH_TOKEN` to repository secrets to automate publishing package
- [ ] login to your `npm` account and create automation token
- [ ] Create a new repository secrets `NPM_AUTH_TOKEN`
- [ ] Update description in `packages/@mayank1513/fork-me/package.json`
- [ ] Imp - update publish workflow - replace `fork-me` with `@mayank1513/fork-me`
- [ ] Update description in `packages/react18-themes/package.json`
- [ ] Imp - update publish workflow - replace `fork-me` with `react18-themes`
- [ ] Create your library and update examples
- [ ] Update README
- [ ] Push your changes/Create PR and see your library being automatically tested and published
Expand Down
2 changes: 1 addition & 1 deletion examples/nextjs/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default function RootLayout({ children }: { children: React.ReactNode })
</a>
</footer>
<ForkMe
gitHubUrl="https://github.com/mayank1513/turbo-template"
gitHubUrl="https://github.com/mayank1513/react18-themes"
bgColor="var(--text-color)"
textColor="var(--bg-color)"
noAutoFork
Expand Down
5 changes: 3 additions & 2 deletions examples/nextjs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nextjs-example",
"version": "1.0.0",
"version": "0.0.0",
"private": true,
"scripts": {
"dev": "next dev",
Expand All @@ -9,7 +9,8 @@
"lint": "next lint"
},
"dependencies": {
"@mayank1513/fork-me": "workspace:*",
"@mayank1513/fork-me": "latest",
"react18-themes": "workspace:*",
"next": "^13.4.19",
"nextjs-themes": "^0.4.0",
"react": "^18.2.0",
Expand Down
3 changes: 2 additions & 1 deletion examples/vite/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"preview": "vite preview"
},
"dependencies": {
"@mayank1513/fork-me": "workspace:*",
"@mayank1513/fork-me": "latest",
"react18-themes": "workspace:*",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react18-themes": "^0.4.0"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@mayank1513/fork-me",
"name": "react18-themes",
"author": "Mayank Kumar Chaudhari <https://mayank-chaudhari.vercel.app>",
"private": false,
"version": "1.0.0",
"version": "0.0.0",
"description": "An intuitive React.js fork me ribbon component for promoting open source project forks.",
"main": "./index.tsx",
"types": "./index.tsx",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ fs.writeFileSync(
JSON.stringify(packageJson, null, 2),
);

fs.copyFileSync(path.resolve(__dirname, "README.md"), path.resolve(__dirname, "dist", "README.md"));
fs.copyFileSync(path.resolve(__dirname, "..", "..", "README.md"), path.resolve(__dirname, "dist", "README.md"));
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
42 changes: 0 additions & 42 deletions setup.sh

This file was deleted.

0 comments on commit f44774b

Please sign in to comment.