/typescript

🌮 | This project is a template for a TypeScript project that uses Bun as the JavaScript runtime and Biome as the linter.

Primary LanguageTypeScript

🌮 My TypeScript Template

This project is a template for a TypeScript project that uses Bun as the JavaScript runtime and Biome as the linter.

🚀 Getting Started

First of all, you need to install the dependencies:

  • Bun - Fast all-in-one JavaScript runtime.
  • Debian - Debian is a free operating system (OS) for your computer.

Then, you need to install the project dependencies:

  • Bun - Fast all-in-one JavaScript runtime.
  • Biome - The blazing fast and configurable linter.
  • CI/CD - Continuous Integration and Continuous Deployment.

📦 Installation

We have two ways to install the project, using a development version or a production version.

🧪 Development Version

1. Install the dependencies:

bun install

2. Run the development script:

bun run dev

🚀 Production Version

1. Install the dependencies:

bun install

2. Build the project, this will generate a dist folder with the production build:

bun run build

3. Run the production build, this will execute the dist/index.js file:

bun run prod

🤝 Contributing

We're open to any contributions, feel free to open an issue or a pull request.

📄 License

This project is licensed under the CC BY-NC 4.0 License.