https://github.com/joaopalmeiro/template-ts-tsx-script
Opinionated TypeScript + tsx template for new scripts.
https://github.com/joaopalmeiro/template-ts-tsx-script
Last synced: about 1 month ago
JSON representation
Opinionated TypeScript + tsx template for new scripts.
- Host: GitHub
- URL: https://github.com/joaopalmeiro/template-ts-tsx-script
- Owner: joaopalmeiro
- License: mit
- Created: 2024-06-20T12:08:14.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T13:18:47.000Z (6 months ago)
- Last Synced: 2025-01-31T07:12:03.314Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# template-ts-tsx-script
Opinionated [TypeScript](https://www.typescriptlang.org/) + [tsx](https://tsx.is/) template for new scripts.
## Getting Started
1. Go to or create the project folder.
2. Get the template files:
```bash
npx giget github:joaopalmeiro/template-ts-tsx-script . --force
```
3. Search for `template-ts-tsx-script` and replace it with the project name. Ignore the template repository URL in the [NOTES.md](NOTES.md) file.
4. Search for `Opinionated TypeScript + tsx template for new scripts.`/`Opinionated [TypeScript](https://www.typescriptlang.org/) + [tsx](https://tsx.is/) template for new scripts.` and replace it with the (short) project description.
5. Search for `João Palmeiro` and replace it with the author's name.
6. Search for `[email protected]` and replace it with the author's email address.
7. Change the `author.url` field in the `package.json` file to the author's website/social media profile.
8. Install [fnm](https://github.com/Schniz/fnm) (if necessary).
9. Run the first two commands in the [`Development`](#development) section to install [Node.js](https://nodejs.org/en) and the development dependencies.
10. Open the [NOTES.md](NOTES.md) file and install the project-specific dependencies according to the first command in the [`Commands`](NOTES.md#commands) section. Run the second command if you are going to use Node.js modules.
11. Delete the [TEMPLATE.md](TEMPLATE.md) file.
12. Delete the [`Getting Started`](#getting-started) section.
## Development
Install [fnm](https://github.com/Schniz/fnm) (if necessary).
```bash
fnm install && fnm use && node --version && npm --version
```
```bash
npm install
```
```bash
npm run dev
```
```bash
npm run lint
```
```bash
npm run format
```