{"id":38127571,"url":"https://github.com/devharnold/smart-notes-api","last_synced_at":"2026-01-16T22:34:45.025Z","repository":{"id":313610012,"uuid":"1052018836","full_name":"devharnold/smart-notes-api","owner":"devharnold","description":"A simple REST API where users can register, log in, and manage personal notes. Notes can include text or markdown,that get stored in AWS S3","archived":false,"fork":false,"pushed_at":"2025-11-01T18:31:35.000Z","size":87,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-01T20:30:04.294Z","etag":null,"topics":["aws-s3","docker","go","pgx"],"latest_commit_sha":null,"homepage":"","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/devharnold.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,"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":"2025-09-07T08:18:24.000Z","updated_at":"2025-11-01T18:31:39.000Z","dependencies_parsed_at":"2025-09-07T10:13:31.338Z","dependency_job_id":"7a62a323-d53d-442f-a91e-f8eb73ec03d9","html_url":"https://github.com/devharnold/smart-notes-api","commit_stats":null,"previous_names":["devharnold/smart-notes-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devharnold/smart-notes-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devharnold%2Fsmart-notes-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devharnold%2Fsmart-notes-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devharnold%2Fsmart-notes-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devharnold%2Fsmart-notes-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devharnold","download_url":"https://codeload.github.com/devharnold/smart-notes-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devharnold%2Fsmart-notes-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28485398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"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":["aws-s3","docker","go","pgx"],"created_at":"2026-01-16T22:34:44.903Z","updated_at":"2026-01-16T22:34:45.008Z","avatar_url":"https://github.com/devharnold.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# smart-notes-api\nA secure REST API where users can register, log in, and manage personal notes. Notes can include text or markdown, and users can upload attachments (images, PDFs) that get stored in AWS S3\n\n\n- **Features:**\n    - User authentication with **JWT**.\n    - CRUD operations for notes.\n    - File uploads (store links in DB, files in S3).\n    - Basic search (by title or content).\n    - Deployment with **Docker**.\n- **Tech stack:**\n    - Go (**Gin**)\n    - **PostgreSQL + pgx**\n    - AWS S3 (storage)\n    - Docker\n\n### Cloning the repo\n\n```\ngit clone https://github.com/devharnold/smart-notes-api.git\n```\n\n### Sync Dependencies\n\n```\ngo mod tidy\n```\n\nThen make sure that you have an environment variables file where you are going to have the Database URL. I did this in mind that I am running on localhost, on the Dockerfile you will see that I have baked the .env file in it.\n\nThen when you build your docker container, build it with:\n\n```\ndocker build -t \"name of your container image\"\n```\n\nIf that works, proceed to run it with:\n\n```\ndocker run -d -p \"your_port:your_port\" --env-file .env --name \"a name to tag the container\" \"name of your container image\"\n```\n\nHere, we use a name to tag the container image to avoid the struggle of trying to find the container with the IDs.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevharnold%2Fsmart-notes-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevharnold%2Fsmart-notes-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevharnold%2Fsmart-notes-api/lists"}