Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for transfer #2

Merged
merged 5 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
- cron: "0 */8 * * *"
jobs:
generate-docs:
if: github.event.repository.owner.login == 'mayank1513'
if: github.event.repository.owner.login == 'react18-tools'
runs-on: ubuntu-latest
permissions:
packages: write
Expand Down Expand Up @@ -37,7 +37,7 @@ jobs:
run: pnpm doc
- name: Setup Git
run: |
git config --global user.name "mayank1513"
git config --global user.name "react18-tools"
git config --global user.email "[email protected]"
git fetch
git checkout main
Expand Down
11 changes: 10 additions & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
publish:
# Don't run just after creating repo from template
# Also avoid running after merging set-up PR
if: github.run_number > 2 && github.event.repository.owner.login == 'mayank1513'
if: github.run_number > 2 && github.event.repository.owner.login == 'react18-tools'
runs-on: ubuntu-latest
permissions:
packages: write
Expand Down Expand Up @@ -55,3 +55,12 @@ jobs:
TOKEN: ${{ secrets.GITHUB_TOKEN }}
OWNER: ${{ github.event.repository.owner.login }}
REPO: ${{ github.event.repository.name }}

- name: Publish package with long name for better SEO
continue-on-error: true
run: |
cd dist
sed -i -e "s/.*name.*/\t\"name\": \"nextjs-themes-ultralight\",/" package.json
npm publish --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
12 changes: 9 additions & 3 deletions .tkb
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,17 @@
"fqhes_YS14GQopOUs7K-7": {
"id": "fqhes_YS14GQopOUs7K-7",
"description": "update workflows to replace mayank1513",
"columnId": "column-todo"
"columnId": "column-done"
},
"-FlzW8htLo-6jz5-ZqjEx": {
"id": "-FlzW8htLo-6jz5-ZqjEx",
"description": "update examples to showcase edge cases",
"columnId": "column-todo"
},
"5fLtFF1sHPxsPjq-wWOxv": {
"id": "5fLtFF1sHPxsPjq-wWOxv",
"description": "Fix turbo-repo template bug - replacing only first doc link in readme --- look at the [doc] with [TypeDoc]",
"columnId": "column-todo"
}
},
"columns": [
Expand All @@ -33,8 +38,8 @@
"title": "To do",
"tasksIds": [
"RtA7NBfPOlfnVHqk54rMD",
"fqhes_YS14GQopOUs7K-7",
"-FlzW8htLo-6jz5-ZqjEx"
"-FlzW8htLo-6jz5-ZqjEx",
"5fLtFF1sHPxsPjq-wWOxv"
]
},
{
Expand All @@ -46,6 +51,7 @@
"id": "column-done",
"title": "Done",
"tasksIds": [
"fqhes_YS14GQopOUs7K-7",
"task-ZJpp-dpxx3KxRMsAPNuMC",
"4CTOhRPjKrEAW5AHYsV7P"
]
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nextjs-Themes-Ultralight

[![test](https://github.com/mayank1513/nthul/actions/workflows/test.yml/badge.svg)](https://github.com/mayank1513/nthul/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/mayank1513/nthul/maintainability) [![codecov](https://codecov.io/gh/mayank1513/nthul/graph/badge.svg)](https://codecov.io/gh/mayank1513/nthul) [![Version](https://img.shields.io/npm/v/nthul.svg?colorB=green)](https://www.npmjs.com/package/nthul) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/nthul.svg)](https://www.npmjs.com/package/nthul) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nthul) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
[![test](https://github.com/react18-tools/nthul/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/nthul/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/react18-tools/nthul/maintainability) [![codecov](https://codecov.io/gh/react18-tools/nthul/graph/badge.svg)](https://codecov.io/gh/react18-tools/nthul) [![Version](https://img.shields.io/npm/v/nthul.svg?colorB=green)](https://www.npmjs.com/package/nthul) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/nthul.svg)](https://www.npmjs.com/package/nthul) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nthul) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)

## Features

Expand Down Expand Up @@ -32,7 +32,7 @@ This template offers following pre-configured features. Additionally, your repo

✅ Workflow to automatically rebrand entire template based on the name of the repo you create from this template. (As soon as you create a repo from this template, setup workflow is triggered which renames nthul to your repo name and does lots of other fixes to set you up and running.)

✅ With all these features, this readme file contains a quick checklist for you to configure Codecov and other badges, setup your docs website on GitHub pages, etc. See [Checklist](https://github.com/mayank1513/nthul/#checklist).
✅ With all these features, this readme file contains a quick checklist for you to configure Codecov and other badges, setup your docs website on GitHub pages, etc. See [Checklist](https://github.com/react18-tools/nthul/#checklist).

#### Create a library that is

Expand All @@ -44,7 +44,7 @@ This template offers following pre-configured features. Additionally, your repo

✅ Works with all build systems/tools/frameworks for React18

✅ Doccumented with [Typedoc](https://mayank1513.github.io/nthul) ([Docs](https://react18-tools.github.io/turborepo-template))
✅ Doccumented with [Typedoc](https://react18-tools.github.io/nthul) ([Docs](https://react18-tools.github.io/nthul))

## Install

Expand Down Expand Up @@ -86,7 +86,7 @@ $ yarn add nthul
- [ ] Create your library and update examples
- [ ] Update README
- [ ] Setup GitHub pages to deploy docs
- [ ] Go to [repo settings](https://github.com/mayank1513/nthul/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
- [ ] Go to [repo settings](https://github.com/react18-tools/nthul/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
- [ ] Push your changes/Create PR and see your library being automatically tested and published
- [ ] Optionally deploy your example(s) to Vercel.
- [ ] You are most welcome to star this template, contribute, and/or sponsor the `terbo-repo-template` project or my other open-source work
Expand Down Expand Up @@ -144,7 +144,7 @@ Learn more about the power of Turborepo:
- [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/nthul)!
### 🤩 Don't forger to start [this repo](https://github.com/react18-tools/nthul)!

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)

Expand Down
154 changes: 77 additions & 77 deletions lib/nthul/package.json
Original file line number Diff line number Diff line change
@@ -1,78 +1,78 @@
{
"name": "nthul",
"author": "Mayank Kumar Chaudhari <https://mayank-chaudhari.vercel.app>",
"private": false,
"version": "0.0.0",
"description": "An intuitive React.js fork me ribbon component for promoting open source project forks.",
"main": "./index.ts",
"types": "./index.ts",
"repository": {
"type": "git",
"url": "git+https://github.com/mayank1513/nthul.git"
},
"bugs": {
"url": "https://github.com/mayank1513/nthul/issues"
},
"homepage": "https://github.com/mayank1513/nthul/tree/main/lib/fork-me#readme",
"sideEffects": false,
"license": "MIT",
"scripts": {
"test": "vitest run --coverage",
"build": "tsup src && tsc -p tsconfig-build.json && node touchup.js",
"doc": "typedoc",
"publish-package": "cd dist && npm publish --provenance --access public",
"lint": "eslint ."
},
"devDependencies": {
"@testing-library/react": "^14.2.1",
"@turbo/gen": "^1.12.4",
"@types/node": "^20.11.19",
"@types/react": "^18.2.57",
"@types/react-dom": "^18.2.19",
"@vitejs/plugin-react": "^4.2.1",
"@vitest/coverage-v8": "^1.3.1",
"esbuild-plugin-css-module": "^0.0.1",
"esbuild-plugin-react18": "^0.0.7",
"eslint-config-custom": "workspace:*",
"jsdom": "^24.0.0",
"octokit": "^3.1.2",
"react": "^18.2.0",
"tsconfig": "workspace:*",
"tsup": "^8.0.2",
"typedoc": "^0.25.8",
"typescript": "^5.3.3",
"vite-tsconfig-paths": "^4.3.1",
"vitest": "^1.3.1"
},
"peerDependencies": {
"@types/react": "16.8 - 18",
"next": "10 - 14",
"react": "16.8 - 18"
},
"peerDependenciesMeta": {
"next": {
"optional": true
}
},
"funding": {
"type": "github",
"url": "https://github.com/sponsors/mayank1513"
},
"keywords": [
"fork-me",
"GitHub",
"nextjs",
"nextjs13",
"react",
"react18",
"react-server-components",
"react-client-components",
"typescript",
"javascript",
"mayank1513",
"turborepo-trmplate"
],
"dependencies": {
"r18gs": "^0.0.2"
}
}
"name": "nthul",
"author": "Mayank Kumar Chaudhari <https://mayank-chaudhari.vercel.app>",
"private": false,
"version": "0.0.0",
"description": "An intuitive React.js fork me ribbon component for promoting open source project forks.",
"main": "./index.ts",
"types": "./index.ts",
"repository": {
"type": "git",
"url": "git+https://github.com/react18-tools/nthul.git"
},
"bugs": {
"url": "https://github.com/react18-tools/nthul/issues"
},
"homepage": "https://github.com/react18-tools/nthul/tree/main/lib/fork-me#readme",
"sideEffects": false,
"license": "MIT",
"scripts": {
"test": "vitest run --coverage",
"build": "tsup src && tsc -p tsconfig-build.json && node touchup.js",
"doc": "typedoc",
"publish-package": "cd dist && npm publish --provenance --access public",
"lint": "eslint ."
},
"devDependencies": {
"@testing-library/react": "^14.2.1",
"@turbo/gen": "^1.12.4",
"@types/node": "^20.11.19",
"@types/react": "^18.2.57",
"@types/react-dom": "^18.2.19",
"@vitejs/plugin-react": "^4.2.1",
"@vitest/coverage-v8": "^1.3.1",
"esbuild-plugin-css-module": "^0.0.1",
"esbuild-plugin-react18": "^0.0.7",
"eslint-config-custom": "workspace:*",
"jsdom": "^24.0.0",
"octokit": "^3.1.2",
"react": "^18.2.0",
"tsconfig": "workspace:*",
"tsup": "^8.0.2",
"typedoc": "^0.25.8",
"typescript": "^5.3.3",
"vite-tsconfig-paths": "^4.3.1",
"vitest": "^1.3.1"
},
"peerDependencies": {
"@types/react": "16.8 - 18",
"next": "10 - 14",
"react": "16.8 - 18"
},
"peerDependenciesMeta": {
"next": {
"optional": true
}
},
"funding": {
"type": "github",
"url": "https://github.com/sponsors/mayank1513"
},
"keywords": [
"fork-me",
"GitHub",
"nextjs",
"nextjs13",
"react",
"react18",
"react-server-components",
"react-client-components",
"typescript",
"javascript",
"mayank1513",
"turborepo-trmplate"
],
"dependencies": {
"r18gs": "^0.0.2"
}
}
4 changes: 2 additions & 2 deletions packages/shared-ui/src/cards/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import { Card } from "./card";

const cards = [
{
href: "https://mayank1513.github.io/nthul/",
href: "https://react18-tools.github.io/nthul/",
title: "Docs",
description: "Explore the official docs.",
},
{
href: "https://github.com/mayank1513/nthul",
href: "https://github.com/react18-tools/nthul",
title: "More Examples",
description: "Explore more examples on official GitHub Repo.",
},
Expand Down
2 changes: 1 addition & 1 deletion packages/shared-ui/src/cards/star-me-card.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import styles from "./cards.module.css";

export function StarMeCard() {
return (
<StarMe className={styles.card} gitHubUrl="https://github.com/mayank1513/nthul">
<StarMe className={styles.card} gitHubUrl="https://github.com/react18-tools/nthul">
<h2>
Star this repo <span>-&gt;</span>
</h2>
Expand Down
6 changes: 5 additions & 1 deletion packages/shared-ui/src/root-layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ export function SharedRootLayout({ children, className = "", ...props }: SharedR
<Cards />
</main>
<Footer />
<ForkMe bgColor="var(--text-color)" gitHubUrl="https://github.com/mayank1513/nthul" textColor="var(--bg-color)" />
<ForkMe
bgColor="var(--text-color)"
gitHubUrl="https://github.com/react18-tools/nthul"
textColor="var(--bg-color)"
/>
</>
);
}
Loading