https://github.com/timbergus/sirocco
This project aims to create a C++ REST server.
https://github.com/timbergus/sirocco
cpp rest server
Last synced: about 24 hours ago
JSON representation
This project aims to create a C++ REST server.
- Host: GitHub
- URL: https://github.com/timbergus/sirocco
- Owner: timbergus
- Created: 2021-09-12T15:29:33.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-08-17T01:51:52.000Z (10 months ago)
- Last Synced: 2025-08-17T03:29:38.524Z (10 months ago)
- Topics: cpp, rest, server
- Language: C++
- Homepage: https://timbergus.github.io/sirocco/
- Size: 1.83 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sirocco
A easy to use C++ REST server. A personal project to learn C++ and improve my knowledge of the Internet. Feel free to fork it and have fun from scratch 🙂
## Files
- **`main`**: The example application to test the library.
- **`actions`**: The callbacks for the server endpoints.
- **`server`**: The server itself.
- **`request`**: Module to handle the client's request.
- **`response`**: Module to handle the server's response.
- **`comm`**: Communication module that stores a request and a response.
- **`http`**: The HTTP tool.
- **`json`**: The JSON tool.
- **`utils`**: Functions to help around.
## Running the Example
The project lives in `src/server` and has a `main.cpp` file as test bench for the library.
All the processes are controlled using `make`. The `Makefile` describe all of them.
- Cleans the project: `make clean`.
- Inits the project: `make init`.
- Builds the project: `make sirocco`.
- Runs the project: `make start`.
- Test the project: `make test`.
## Testing the Server
To test the server, there is a `test.http` file that can be run using the VSCode extension [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
## Documentation
The documentation has been created as a GitHub page. The project is written using [React](https://reactjs.org/), and lives in `src/www`.
### Development
- `cd src/www`.
- `yarn`.
- `yarn dev`.
And after your changes are production ready.
- `yarn build`.
The result of the build will be stored in the `docs` folder and published by GitHub.