https://github.com/hugodf/real-world-ts
https://github.com/hugodf/real-world-ts
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/hugodf/real-world-ts
- Owner: HugoDF
- License: mit
- Created: 2025-06-14T09:53:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-14T10:53:25.000Z (about 1 year ago)
- Last Synced: 2025-06-14T11:34:20.787Z (about 1 year ago)
- Language: TypeScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [Project Name]
Boilerplate repo with:
- MIT License
- Node, npm
- tests with the `node:test` built-in
- formatting with prettier
- GitHub Actions on commit and to auto-publish on GH release
- **note**: for publish to work, `NPM_TOKEN` has to be set in the repository GH Actions secrets
## Requirements
- Node 20
- npm v8+
## Setup
1. Clone the repository
2. Run `npm install` installs all required dependencies.
## npm scripts
- `npm test` will run tests using the [Node.js test runner](https://nodejs.org/api/test.html#running-tests-from-the-command-line) and the `node:test` module.
- `npm run format` will run prettier on all the examples files (and tests).
## LICENSE
Code is licensed under the [MIT License](./LICENSE).