|
1 |
| -# nthul |
| 1 | +# Nextjs-Themes-Ultralight |
2 | 2 |
|
3 | 3 | [](https://github.com/mayank1513/nthul/actions/workflows/test.yml) [](https://codeclimate.com/github/mayank1513/nthul/maintainability) [](https://codecov.io/gh/mayank1513/nthul) [](https://www.npmjs.com/package/nthul) [](https://www.npmjs.com/package/nthul)  [](https://gitpod.io/from-referrer/)
|
4 | 4 |
|
|
64 | 64 | $ yarn add nthul
|
65 | 65 | ```
|
66 | 66 |
|
67 |
| - |
68 |
| - |
69 |
| - |
70 |
| -## Getting started: |
71 |
| - |
72 |
| -Click on the `"Use this template"` button to customize it for your next JavaScript/TypeScript/React/Vue/Next.js library or project. |
73 |
| - |
74 |
| -## What's Different? |
75 |
| - |
76 |
| -Compared to the default scaffold from create-turbo, this template offers: |
77 |
| - |
78 |
| -- Unit tests with `vitest` |
79 |
| -- Build setup with `tsup` and `esbuild-react18-useclient` Supports React Server components out of the box |
80 |
| -- **Automatic file generation** |
81 |
| - - just run `yarn turbo gen` and follow the prompts to auto generate your new component with test file and dependency linking |
82 |
| - - follow best practices automatically |
83 |
| -- GitHub actions/workflows to auto publish your package when version changes |
84 |
| -- GitHub action/workflow + preinstall scripts to automatically rebrand your repo on creation |
85 |
| - |
86 | 67 | ## Step by Step Instructions and Checklist
|
87 | 68 |
|
88 |
| -- [ ] Star [this repo](https://github.com/mayank1513/nthul/) so that you and others can find it more easily for your next projects. It also helps me understand that people are using this repo so that I can maintain the repo and the documentation well. |
89 |
| - |
90 |
| -- [ ] Install and setup Node.js and IDE (I prefer VSCode) |
91 |
| -- [ ] Install the recommended VSCode extensions - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), [Trello Kanban](https://marketplace.visualstudio.com/items?itemName=mayank1513.trello-kanban-task-board) |
92 | 69 | - [ ] Install dependencies using `pnpm`
|
93 |
| - - [ ] If you don't have `pnpm` installed, run `npm i -g pnpm` to install `pnpm` -> run `pnpm setup` to set up `pnpm` for global installations |
94 |
| - - [ ] Run `pnpm i` to install dependencies and `preinstall` script will automatically touch up workflows and create a commit |
95 |
| - - [ ] Run `pnpm i -g turbo` to install `turbo` globally (Sometime due to `TypeScript` and `Plop` version conflicts code generation requires global `turbo`). |
96 | 70 | - [ ] Run `turbo gen react-component`, and follow prompts to generate server or client components for your library
|
97 | 71 | - [ ] Use `snake-case` for your component name - it will be automatically converted to `PascalCase`
|
98 | 72 | - [ ] Your component and test files will be created in `**/src/client/` or `**/src/server/` directory depending on whether you choose `client` or `server` component
|
|
0 commit comments