SelfPrivacy
/
selfprivacy-rest-api
mirror of https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'docs(api): add a CI badge' (#107) from ci-badge into master 

Reviewed-on: https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api/pulls/107
Reviewed-by: Inex Code <inex.code@selfprivacy.org>
This commit is contained in:
Inex Code 2024-03-18 19:28:31 +02:00
parent efc6b47cfe f2446dcee2
commit 5ec677339b
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,8 @@
# SelfPrivacy GraphQL API which allows app to control your server # SelfPrivacy GraphQL API which allows app to control your server
## build ![CI status](https://ci.selfprivacy.org/api/badges/SelfPrivacy/selfprivacy-rest-api/status.svg)
## Build
```console ```console
$ nix build $ nix build
@ -8,7 +10,7 @@ $ nix build
In case of successful build, you should get the `./result` symlink to a folder (in `/nix/store`) with build contents. In case of successful build, you should get the `./result` symlink to a folder (in `/nix/store`) with build contents.
## develop ## Develop
```console ```console
$ nix develop $ nix develop
@ -21,10 +23,10 @@ Type "help", "copyright", "credits" or "license" for more information.
If you don't have experimental flakes enabled, you can use the following command: If you don't have experimental flakes enabled, you can use the following command:
```console ```console
nix --extra-experimental-features nix-command --extra-experimental-features flakes develop $ nix --extra-experimental-features nix-command --extra-experimental-features flakes develop
``` ```
## testing ## Testing
Run the test suite by running coverage with pytest inside an ephemeral NixOS VM with redis service enabled: Run the test suite by running coverage with pytest inside an ephemeral NixOS VM with redis service enabled:
```console ```console
@ -61,7 +63,7 @@ $ TMPDIR=".nixos-vm-tmp-dir" nix run .#checks.x86_64-linux.default.driverInterac
Option `-L`/`--print-build-logs` is optional for all nix commands. It tells nix to print each log line one after another instead of overwriting a single one. Option `-L`/`--print-build-logs` is optional for all nix commands. It tells nix to print each log line one after another instead of overwriting a single one.
## dependencies and dependant modules ## Dependencies and Dependant Modules
This flake depends on a single Nix flake input - nixpkgs repository. nixpkgs repository is used for all software packages used to build, run API service, tests, etc. This flake depends on a single Nix flake input - nixpkgs repository. nixpkgs repository is used for all software packages used to build, run API service, tests, etc.
@ -85,6 +87,6 @@ $ nix flake metadata git+https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nix
Nix code for NixOS service module for API is located in NixOS configuration repository. Nix code for NixOS service module for API is located in NixOS configuration repository.
## troubleshooting ## Troubleshooting
Sometimes commands inside `nix develop` refuse to work properly if the calling shell lacks `LANG` environment variable. Try to set it before entering `nix develop`. Sometimes commands inside `nix develop` refuse to work properly if the calling shell lacks `LANG` environment variable. Try to set it before entering `nix develop`.