{"id":15272407,"url":"https://github.com/batnoter/batnoter-api","last_synced_at":"2026-01-12T00:53:08.945Z","repository":{"id":37399319,"uuid":"495740268","full_name":"batnoter/batnoter-api","owner":"batnoter","description":"The API backend for BatNoter. Built with Golang","archived":false,"fork":false,"pushed_at":"2022-06-23T13:56:31.000Z","size":172,"stargazers_count":49,"open_issues_count":1,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-02T12:27:20.864Z","etag":null,"topics":["container-ready","contributions-welcome","gin","github","github-oauth2","go","golang","gomock","gorm","markdown","notes","notes-api"],"latest_commit_sha":null,"homepage":"https://api.batnoter.com","language":"Go","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/batnoter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-24T08:45:32.000Z","updated_at":"2025-02-04T04:38:15.000Z","dependencies_parsed_at":"2022-07-08T16:47:26.714Z","dependency_job_id":null,"html_url":"https://github.com/batnoter/batnoter-api","commit_stats":null,"previous_names":["git-noter/gitnoter-api","vivekweb2013/gitnoter-api"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/batnoter/batnoter-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/batnoter","download_url":"https://codeload.github.com/batnoter/batnoter-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010260,"owners_count":26084719,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["container-ready","contributions-welcome","gin","github","github-oauth2","go","golang","gomock","gorm","markdown","notes","notes-api"],"created_at":"2024-09-30T09:06:14.917Z","updated_at":"2025-10-12T04:36:24.737Z","avatar_url":"https://github.com/batnoter.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## BatNoter API Module\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/batnoter/batnoter-api/Test/main?color=forestgreen)](https://github.com/batnoter/batnoter-api/actions?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/batnoter/batnoter-api/branch/main/graph/badge.svg?token=pWRurWucMC)](https://codecov.io/gh/batnoter/batnoter-api)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f13246b96cd047b5b5dddcbceb2cad9e)](https://www.codacy.com/gh/batnoter/batnoter-api/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=batnoter/batnoter-api\u0026amp;utm_campaign=Badge_Grade)\n\nThis is the api service of batnoter application built with golang.\n\nIt exposes ReST endpoints to access and manage markdown notes from user's git repository. Currently it only supports github repository for storing \u0026 managing notes.\n\n### Local Development Setup\n\n#### Prerequisites\n*   Go version `1.18` or above\n*   Docker Desktop\n\n#### Start postgres database container\nBelow commands use docker to start the database container.\n```shell\nmake network\nmake postgres\nmake createdb\n```\n\n#### Create configuration file from template\nThe `config.yaml` is the configuration template file containing default config values.\n```shell\ncp config.yaml .config.yaml\n```\nApplication uses `.config.yaml` file to get the config values. Please update placeholder-values from this config file to the actual ones. \n\n#### Start the server\nMake sure that the `.config.yaml` file is configured correctly \u0026 database container is up \u0026 running.\nThen run the below commands to setup the db schema and start the web server.\n```shell\ngo run main.go migrateup\ngo run main.go serve\n```\nThis will start the server on port specified in `.config.yaml` file. You can now access the api endpoints.\n\n#### Run tests\n```shell\ngo test -v -cover ./...\n```\nThis will execute all the tests and also prints the code coverage percentage.\n\n### Contribution Guidelines\n\u003e Every Contribution Makes a Difference\n\nRead the [Contribution Guidelines](CONTRIBUTING.md) before you contribute.\n\n### Special Thanks\n[![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://jb.gg/OpenSourceSupport)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbatnoter%2Fbatnoter-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbatnoter%2Fbatnoter-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbatnoter%2Fbatnoter-api/lists"}