An open API service indexing awesome lists of open source software.

https://github.com/vibecc/create-vibe

npx create-vibe-static
https://github.com/vibecc/create-vibe

npx package vibe

Last synced: 26 days ago
JSON representation

npx create-vibe-static

Awesome Lists containing this project

README

          

# Vibe 🍃

**User-friendly and compact C++ Web Framework**


vibe image

## Table of Contents
1. [Installation](#installation)
- [cmake](#cmake)
- [npm](#npm)
2. [Usage](#usage)
3. [Compile](#compile)
4. [Examples](#examples)
5. [Support](#support)
6. [Contribution](#contribution)
7. [License](#license)

## Installation

To install Vibe

### cmake

CMake

```shell
$ git clone https://github.com/vibecc/core
$ cd Vibe
$ cmake .
$ cmake --build .
$ make install
```

### npm

NodeJS

#### ready to use
```shell
$ npm create vibe-static
```

## Usage

To use Vibe in your project, include the header files and link the static library in your C++ compiler.

```cpp
#include

int main() {

Router router;
router.setPort(8080);

router.get("/",{[&](Query &web) {
web.send("Hello World");
}});

router.listen();
}
```

## Compile
#### compile your project
```bash
$ g++ -std=c++17 main.cpp -o server -L. -lvibe
```

## Examples

In the `examples/` folder (github repo), you'll find examples of how to use Vibe for different use cases, such as dynamic routes, form handling, etc.

## Support

Linux

## Contribution

Contributions are welcome! If you want to contribute to Vibe, please follow these guidelines:
- Fork the repository.
- Create a branch for your new feature (`git checkout -b feature/new-feature`).
- Make your changes and commit meaningful messages.
- Push your branch (`git push origin feature/new-feature`).
- Create a pull request.

## License

This project is licensed under the [MIT License](LICENSE).