{"id":41014814,"url":"https://github.com/junkidesu/learning-junkie-api","last_synced_at":"2026-01-22T09:15:54.852Z","repository":{"id":227933478,"uuid":"768179383","full_name":"junkidesu/learning-junkie-api","owner":"junkidesu","description":"Learning Junkie REST API","archived":false,"fork":false,"pushed_at":"2025-11-22T16:40:28.000Z","size":335,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-22T17:28:30.886Z","etag":null,"topics":["amazon-s3","api","aws","beam","beam-postgres","docker","docker-compose","education","haskell","minio","postgresql","rest","servant","servant-auth-server"],"latest_commit_sha":null,"homepage":"https://learning-junkie.onrender.com","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/junkidesu.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-03-06T16:03:21.000Z","updated_at":"2025-11-22T16:40:31.000Z","dependencies_parsed_at":"2024-04-27T11:39:01.147Z","dependency_job_id":"35ca54cc-96f3-42d9-bb5c-6769d1262d63","html_url":"https://github.com/junkidesu/learning-junkie-api","commit_stats":null,"previous_names":["luminous-or-me/learning-junkie-api","junkidesu/learning-junkie-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/junkidesu/learning-junkie-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/junkidesu%2Flearning-junkie-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/junkidesu%2Flearning-junkie-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/junkidesu%2Flearning-junkie-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/junkidesu%2Flearning-junkie-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/junkidesu","download_url":"https://codeload.github.com/junkidesu/learning-junkie-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/junkidesu%2Flearning-junkie-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28660203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T01:17:37.254Z","status":"online","status_checked_at":"2026-01-22T02:00:07.137Z","response_time":144,"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":["amazon-s3","api","aws","beam","beam-postgres","docker","docker-compose","education","haskell","minio","postgresql","rest","servant","servant-auth-server"],"created_at":"2026-01-22T09:15:54.327Z","updated_at":"2026-01-22T09:15:54.842Z","avatar_url":"https://github.com/junkidesu.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Learning Junkie REST API\n\nThis repository contains the source code for the Learning Junkie REST API.\n\n## Technologies Used\n\n- [Haskell](https://www.haskell.org/)\n- [Servant](https://docs.servant.dev/en/stable/index.html) (API)\n- [Beam](https://hackage.haskell.org/package/beam-core) (DB)\n- [PostgreSQL](https://www.postgresql.org/) (DB)\n- [Lucid](https://hackage.haskell.org/package/lucid) (Certificate Generation)\n- [Amazon S3](https://aws.amazon.com/s3/) (Storage)\n- [MinIO](https://www.min.io/) (Storage, local environment)\n- [Docker](https://www.docker.com/)\n- [GitHub Actions](https://docs.github.com/en/actions) (CI/CD)\n\n## Getting Started\n\nFirst and foremost, clone the repository on your local machine:\n\n```sh\n$ git clone https://github.com/junkidesu/learning-junkie-api\n```\n\n### Prerequisites\n\n#### Build Tools\n\nTo build and run the application locally, ensure that the following are installed:\n\n- [Stack](https://docs.haskellstack.org/en/stable/)\n- [Cabal](https://cabal.readthedocs.io/en/stable/)\n- [Docker](https://www.docker.com/)\n\nStack and Cabal can be installed either independently or with the [GHCup](https://www.haskell.org/ghcup/) tool.\n\n#### Services\n\nThe application uses PostgreSQL for the database and Amazon S3 for storage. Thus, a running PostgreSQL server (either local or remote), as well as a publicly readable [Amazon S3 Bucket](https://aws.amazon.com/s3/), are required.\n\nBecause spinning up an Amazon S3 bucket can be a little tedious, it is also possible to use a [MinIO bucket](https://www.min.io/) on your local machine. In fact, MinIO is included as a service in the `docker-compose.dev.yml` file.\n\n#### Environment Variables\n\nSee [`.env.sample`](./.env.sample) to see the environment variables that must be set. You can either place them in a `.env` file, or supply them directly to the executable.\n\n### Build and Start Executable\n\nAt the root of the repository, run the following:\n\n```sh\n$ stack install\n$ learning-junkie-api-exe\n```\n\n### Start in Container\n\nYou may start the application along with a local PostgreSQL server and a local MinIO bucket using Docker Compose.\n\n```sh\n$ docker compose -f docker-compose.dev.yml up\n```\n\nYou still need to supply the necessary environment variables, though.\n\n## Documentation\n\nWhen the server is started on the local machine, documentation is available at http://localhost:3003/swagger-ui (you might need to change the port).\n\nFor the application running in production, the Swagger documentation of the API is available at https://learning-junkie-api-main.onrender.com/swagger-ui.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjunkidesu%2Flearning-junkie-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjunkidesu%2Flearning-junkie-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjunkidesu%2Flearning-junkie-api/lists"}