Welcome to the Bun project template repository! This template provides a starting point for creating new projects using bun. With bun, you can quickly build modern JavaScript and TypeScript applications.
-
Bun Ready: This template is preconfigured with Bun, a fast and simple framework for building web applications.'
-
TypeScript This template is built with TypeScript and includes a ready to go tsconfig setup
-
ESLint Integration: Ensure code quality with ESLint, including TypeScript support and a pre-configured set of rules.
-
Test Coverage: Run tests with coverage reports to ensure your application is well-tested.
If you haven't already, install bun. Follow the directions here
To create a new project using this template, follow these steps:
-
Click the "Use this template" button at the top of the repository to create a new repository based on this template.
-
Clone your newly created repository to your local machine:
git clone https://github.com/your-username/your-new-project.git cd your-new-project
Install project dependencies:
bun installStart building your Bun project by modifying the index.ts file and adding your application code.
To lint your code:
bun lint
To run tests:
bun test
The project template follows a typical directory structure for Bun projects:
index.ts: The entry point for your application. src/: Directory for your application source code. tests/: Directory for your tests..eslintrc.cjs: ESLint configuration file.package.json: Project configuration, including scripts and dependencies./modules: Contains the modules you are creating/types: Contains TypeScript types that are shared across your repository/test: Contains tests for the modules you have created
If you have suggestions, bug reports, or would like to contribute to this project template, please open an issue or submit a pull request on the GitHub repository.
This project is licensed under the MIT License - see the LICENSE file for details.