Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.md #14

Merged
merged 1 commit into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Project Name

A brief description of what your project does.

## Table of Contents

- [Project Name](#project-name)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Project](#running-the-project)
- [License](#license)

## Getting Started

### Prerequisites

Make sure you have [Bun](https://bun.sh/) installed.

You can install it by following the guide [here](https://bun.sh/docs/installation)

## Installation

Install dependencies:

```sh
bun install
```

## Running the Project

To start the development server, run:

```sh
bun run dev
```

To build the project for production, run:

```sh
bun run build
```

To run tests, use:

```sh
bun run test
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Binary file modified bun.lockb
Binary file not shown.