https://github.com/dmtai/realworld_service
Implementation of realworld app backend api
https://github.com/dmtai/realworld_service
cmake cpp cpp17 example-project plpgsql postgresql python realworld realworld-backend userver
Last synced: 5 months ago
JSON representation
Implementation of realworld app backend api
- Host: GitHub
- URL: https://github.com/dmtai/realworld_service
- Owner: dmtai
- License: mit
- Created: 2023-07-16T19:50:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-17T21:18:21.000Z (about 2 years ago)
- Last Synced: 2025-04-01T06:02:40.761Z (6 months ago)
- Topics: cmake, cpp, cpp17, example-project, plpgsql, postgresql, python, realworld, realworld-backend, userver
- Language: C++
- Homepage: https://realworld.io
- Size: 228 KB
- Stars: 9
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
This codebase was created to demonstrate a fully fledged backend application built with **[userver framework](https://userver.tech/)** and **[PostgreSQL](https://www.postgresql.org/)** including CRUD operations, authentication, routing, pagination, and more.
For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
## Build and run
The DB will be prepared and started and the service will be started on http://localhost:8080.
### Docker-compose
```
# Clone submodules
git submodule update --init
# Run service
make docker-start-service-release
```
### Local
```
make service-start-release
```
## Tests
Run unit and functional tests in docker or local.
### Docker-compose
```
make docker-test-release
```
### Local
```
make test-release
```
## Makefile
* `make build-debug` - debug build of the service with all the assertions and sanitizers enabled
* `make build-release` - release build of the service with LTO
* `make test-debug` - does a `make build-debug` and runs all the tests on the result
* `make test-release` - does a `make build-release` and runs all the tests on the result
* `make service-start-debug` - builds the service in debug mode and starts it
* `make service-start-release` - builds the service in release mode and starts it
* `make` or `make all` - builds and runs all the tests in release and debug modes
* `make format` - autoformat all the C++ and Python sources
* `make clean-` - cleans the object files
* `make dist-clean` - clean all, including the CMake cached configurations
* `make install` - does a `make build-release` and runs install in directory set in environment `PREFIX`
* `make install-debug` - does a `make build-debug` and runs install in directory set in environment `PREFIX`
* `make docker-COMMAND` - run `make COMMAND` in docker environment
* `make docker-build-debug` - debug build of the service with all the assertions and sanitizers enabled in docker environment
* `make docker-test-debug` - does a `make build-debug` and runs all the tests on the result in docker environment
* `make docker-build-release` - release build of the service with all the assertions and sanitizers enabled in docker environment
* `make docker-test-release` - does a `make build-release` and runs all the tests on the result in docker environment
* `make docker-start-service-release` - does a `make install-release` and runs service in docker environment
* `make docker-start-service-debug` - does a `make install-debug` and runs service in docker environment
* `make docker-clean-data` - stop docker containers and clean database data