{"id":21538373,"url":"https://github.com/rarimo/rarime-link-svc","last_synced_at":"2025-03-17T20:47:59.601Z","repository":{"id":212318480,"uuid":"731082609","full_name":"rarimo/rarime-link-svc","owner":"rarimo","description":"Rarime Link Service stores users proofs and provide simple access to it via REST API in JSON:API format.","archived":false,"fork":false,"pushed_at":"2024-04-02T09:06:20.000Z","size":358,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-24T07:45:55.815Z","etag":null,"topics":["golang","rarime","zkp"],"latest_commit_sha":null,"homepage":"https://rarimo.github.io/rarime-link-svc/","language":"Smarty","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/rarimo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-13T10:16:20.000Z","updated_at":"2023-12-18T16:53:09.000Z","dependencies_parsed_at":"2024-01-22T19:06:25.983Z","dependency_job_id":"dc32cf65-9afb-4c2c-9aff-26836af4d045","html_url":"https://github.com/rarimo/rarime-link-svc","commit_stats":null,"previous_names":["rarimo/dashboard-rarime-link-svc","rarimo/rarime-link-svc"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Frarime-link-svc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Frarime-link-svc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Frarime-link-svc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rarimo%2Frarime-link-svc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rarimo","download_url":"https://codeload.github.com/rarimo/rarime-link-svc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244110091,"owners_count":20399562,"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","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":["golang","rarime","zkp"],"created_at":"2024-11-24T04:11:47.145Z","updated_at":"2025-03-17T20:47:59.576Z","avatar_url":"https://github.com/rarimo.png","language":"Smarty","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rarime Link Service\n\nRarime Link Service stores users proofs and provide simple access to it via REST API in [JSON:API] format.\n\n## Getting Started\n### Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- Docker installed, see [Docker installation guide]\n- Go 1.20 installed, see [Go installation guide]\n\n\n### Building\n\n#### Binary\nTo build the service binary file, follow these steps:\n\n1. Clone the repository.\n\n    ```bash\n    git clone github.com/rarimo/rarime-link-svc\n    cd rarime-link-svc\n    ```\n\n1. Install dependencies and build the service.\n\n    ```bash\n    go mod tidy\n    go build main.go\n    ```\n\n#### Docker\n\nTo build the service Docker image, follow these steps:\n\n\n1. Clone the repository.\n\n    ```bash\n    git clone github.com/rarimo/rarime-link-svc\n    cd rarime-link-svc\n    ```\n\n1. Build the service image.\n\n    ```bash\n    sh ./build.sh\n    ```\n\n### Configuration\n\nTo properly configure the service, provide valid config file, see [config-example.yaml](config-example.yaml)\nfor example.\n\n### Running with Docker\n\nTo run the service using Docker, follow these steps:\n\n1. Build the service image, see [Building](#building).\n1. Run the service image.\n\n    ```bash\n    docker-compose up -d\n    ```\n1. The service will be available on the `8000` port.\n\n## Usage\n\nTo use the service, you could use the swagger documentation, see [API Documentation](#api-documentation), or\nany other http client.\n\n## API Documentation\n\nWe use [openapi:json] standard for API. We use swagger for documenting our API.\n\nTo open online documentation, go to [swagger editor], here is how you can start it\n```bash\n  cd docs\n  npm install\n  npm start\n```\nTo build documentation use `npm run build` command,\nthat will create open-api documentation in `web_deploy` folder.\n\nTo generate resources for Go models run `./generate.sh` script in root folder.\nuse `./generate.sh --help` to see all available options.\n\n## Contributing\n\nWe welcome contributions from the community! To contribute to this project, follow these steps:\n\n1. Fork the repository.\n1. Create a new branch with a descriptive name for your feature or bug fix.\n1. Make your changes and commit them.\n1. Push your changes to your branch on your GitHub fork.\n1. Create a pull request from your branch to the `main` branch of this repository.\n\nPlease ensure your pull request adheres to the following guidelines:\n- Add a clear pull request title;\n- Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;\n- Update the [CHANGELOG.md](CHANGELOG) accordingly;\n- Keep the codebase clean and well-documented;\n- Make sure your code is properly tested;\n- Reference any related issues in your pull request;\n\nThe maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!\n\n## Changelog\n\nFor the changelog, see [CHANGELOG.md](CHANGELOG).\n\n## License\n\nThis project is under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n[JSON:API]: https://jsonapi.org/\n[Docker installation guide]: https://docs.docker.com/get-docker/\n[Go installation guide]: https://golang.org/doc/install\n[swagger editor]: http://localhost:8080/swagger-editor/\n[openapi:json]: https://www.openapis.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Frarime-link-svc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frarimo%2Frarime-link-svc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frarimo%2Frarime-link-svc/lists"}