https://github.com/khattakdev/bunify

https://github.com/khattakdev/bunify

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/khattakdev/bunify
• Owner: khattakdev
• License: mit
• Created: 2023-10-10T05:27:59.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-22T12:15:43.000Z (about 1 year ago)
• Last Synced: 2024-10-20T07:41:58.886Z (26 days ago)
• Language: TypeScript
• Size: 24.4 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Bunify

Bunify is a simplistic framework for Bun.sh, designed to bring an Express.js-like experience to the Bun ecosystem.

## Features

- Simplified HTTP methods (`app.get`, `app.post`, `app.put`, `app.delete`)

- RegEx support (`/ab+cd`, `/ab*cd`, `/a(cd)?e`)

- Easy setup and usage

- Dynamic URL routing (`/users/:id`) (🚧 In progress)

## Installation

Ensure you have [Bun.sh](https://bun.sh) installed on your machine.

```bash

# Clone the repository

git clone https://github.com/khattakdev/bunify.git

# Navigate to the project directory

cd bunify

# Install dependencies and build the project

bun install

```

To try the npm package, use the following command:

```

npm install bunify

```

## Usage

```javascript

// Import the Bunify framework

import App from "bunify";

// Create a new app instance

const app = new App();

// Define a simple GET route

app.get("/", (req, res) => {

  return res.send("Hello World!");

});

// Start listening on port 3001

app.listen(3001, () => {

  console.log("Server is running on http://localhost:3001");

});

```

## Testing

Bunify uses Bun's built-in testing utilities for writing and running tests.

```bash

# Run tests

bun test

```

## Contributing

Feel free to fork this repository, submit issues, or open pull requests to help improve Bunify.

## License

[MIT](LICENSE)