{"id":25940892,"url":"https://github.com/d-ashesss/nulland","last_synced_at":"2026-04-28T16:36:59.257Z","repository":{"id":186202008,"uuid":"674811621","full_name":"d-ashesss/nulland","owner":"d-ashesss","description":"Note taking REST API with Python and FastAPI","archived":false,"fork":false,"pushed_at":"2023-09-10T17:24:13.000Z","size":86,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T05:20:49.053Z","etag":null,"topics":["fastapi","jwt","oauth2","postgresql","python","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/d-ashesss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-04T21:03:17.000Z","updated_at":"2023-09-10T17:18:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"c88462b8-6dc5-4fa6-a3f9-bccb292eca77","html_url":"https://github.com/d-ashesss/nulland","commit_stats":null,"previous_names":["d-ashesss/nulland"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/d-ashesss/nulland","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-ashesss%2Fnulland","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-ashesss%2Fnulland/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-ashesss%2Fnulland/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-ashesss%2Fnulland/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/d-ashesss","download_url":"https://codeload.github.com/d-ashesss/nulland/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-ashesss%2Fnulland/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32390050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T14:34:11.604Z","status":"ssl_error","status_checked_at":"2026-04-28T14:32:37.009Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","jwt","oauth2","postgresql","python","rest-api"],"created_at":"2025-03-04T05:19:40.172Z","updated_at":"2026-04-28T16:36:59.219Z","avatar_url":"https://github.com/d-ashesss.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Note taking API\n\nREST API backend for note taking application.\n\n[![test status](https://github.com/d-ashesss/nulland/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/d-ashesss/nulland/actions/workflows/test.yml)\n[![MIT license](https://img.shields.io/github/license/d-ashesss/nulland?color=blue)](https://opensource.org/licenses/MIT)\n[![latest tag](https://img.shields.io/github/v/tag/d-ashesss/nulland?include_prereleases\u0026sort=semver)](https://github.com/d-ashesss/nulland/tags)\n![feline reference](https://img.shields.io/badge/may%20contain%20cat%20fur-%F0%9F%90%88-blueviolet)\n\n## Running the app\n\nTo run the app first you must install the dependencies from requirements.txt then use Uvicorn to run the app.\n\n```bash\npip install -r requirements.txt\npython -m uvicorn app.main:app\n```\n\nAlternalively, to run in Docker (provide environment variables as needed):\n\n```bash\ndocker run -p 8000:8000 -e 'DATABASE_URI=postgresql://postgres:postpwd@localhost' -e 'AUTH_OPENID_CONFIGURATION_URL=https://accounts.google.com/.well-known/openid-configuration' ashesss/nulland:latest\n```\n\nOr even with docker compose, configure environment in `docker-compose.override.yml` (see [example](https://github.com/d-ashesss/nulland/wiki/example-docker%E2%80%90compose.override.yml)), then simply run:\n```bash\ndocker-compose up\n```\n\n## Configuration\n\n### Authentication\n\nThe API handles authentication using JWT tokens. The token is passed in the `Authorization` header as a bearer token. It is possible to use OIDC service like [Auth0](https://auth0.com) to obtain the token and then use it with this API. It is required to provide the app with the URL to the OIDC discovery documents in the `AUTH_OPENID_CONFIGURATION_URL` environment variable.\n\n### Database\n\nThe API uses PostgreSQL database. The connection string must be passed in the `DATABASE_URL` environment variable.\n\n### Logging\n\nTo get the log format compatible with Google Cloud structured logging, set the `LOG_FORMAT` environment variable to `json`.\n\n### Event logging\n\nApplication is able to post events to Kafka topic. To configure this feature set `EVENT_PRODUCER` environment variable to `kafka` and the hostname of Kafka server in `KAFKA_BOOTSTRAP_SERVERS` variable. Additionaly, `KAFKA_SASL_USERNAME` and `KAFKA_SASL_PASSWORD` must be set if Kafka server requires authentication.\n\n### CORS\n\nTo configure CORS to allow access from a specific domain, set the `CORS_ALLOWED_ORIGINS` environment variable to JSON-formatted list of allowed URLs,\nfor example `CORS_ALLOWED_ORIGINS='[\"http://localhost:5000\"]'`.\n\n## API documentation\n\nOpenAPI documentation is available at `/docs` endpoint.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd-ashesss%2Fnulland","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fd-ashesss%2Fnulland","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd-ashesss%2Fnulland/lists"}