{"id":31793552,"url":"https://github.com/singhdurgesh/rednote","last_synced_at":"2026-05-03T01:39:19.693Z","repository":{"id":237901182,"uuid":"795455759","full_name":"singhdurgesh/rednote","owner":"singhdurgesh","description":"Boilerplate Web Application with Go, Postgres, Redis, RabbitMQ, and CI/CD Integration","archived":false,"fork":false,"pushed_at":"2024-06-12T16:59:57.000Z","size":178,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-19T07:38:04.051Z","etag":null,"topics":["boilerplate","chat-application","database-migrations","docker","docker-compose","go","go-gin","golang","postgres","rabbitmq","real-time","user-authentication"],"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/singhdurgesh.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}},"created_at":"2024-05-03T10:16:35.000Z","updated_at":"2025-10-01T14:00:14.000Z","dependencies_parsed_at":"2024-06-19T14:34:49.848Z","dependency_job_id":"2c388ce8-ddb8-4e14-95c9-b02851fe6e36","html_url":"https://github.com/singhdurgesh/rednote","commit_stats":null,"previous_names":["singhdurgesh/rednote"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/singhdurgesh/rednote","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singhdurgesh%2Frednote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singhdurgesh%2Frednote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singhdurgesh%2Frednote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singhdurgesh%2Frednote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/singhdurgesh","download_url":"https://codeload.github.com/singhdurgesh/rednote/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singhdurgesh%2Frednote/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32555839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T00:31:16.350Z","status":"ssl_error","status_checked_at":"2026-05-03T00:31:15.546Z","response_time":132,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["boilerplate","chat-application","database-migrations","docker","docker-compose","go","go-gin","golang","postgres","rabbitmq","real-time","user-authentication"],"created_at":"2025-10-10T18:20:20.049Z","updated_at":"2026-05-03T01:39:19.674Z","avatar_url":"https://github.com/singhdurgesh.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rednote\n\n## Description\nRednote is a Go-based backend project designed to provide a comprehensive set of user authentication methods, real-time chat and location tracking APIs, job/task processing, and a structured deployment pipeline. This repository aims to offer a robust and scalable backend solution for modern web and mobile applications.\n\n## Features\n### User Registration Methods\n- **Using Username/Password** - Done\n- **Using OTP on Phone/Email** - Done\n- **Using Google SSO** - Done\n- Using Apple SSO\n\n### User Login Methods\n- **Using Username/Password** - Done\n- **Using OTP on Phone/Email** - Done\n- **Using Google SSO** - Done\n- Using Apple SSO\n\n### User Password Reset\n- Using OTP on Phone/Email\n\n### Settings CRUD API\n- **Accessible only for Admin User** - Done\n\n### Real-Time Features\n- Real-Time Chat Application APIs\n- Real-Time Location Tracking APIs\n\n### Database Management\n- **Versioned Database Migration with Goose Package** - Done\n\n### Job/Task Processing\n- **RabbitMQ Integration** - Done\n- **Machinery Package Integration** - Done\n- **AsyncTask Module** - Done\n  - **Notification Task Example** - Done\n- AWS SQS Integration\n\n### Notification Service\n- **Abstract and Implementation of a Service** - Done\n\n### Deployment Pipelines Setup\n- **Docker Setup**\n  - **Dockerfile Creation** - Done\n  - **Docker Compose File** - Done\n- **Github Pipelines**\n  - **Workflow Setup** - Done\n  - Workflow Deployment to AWS EC2\n\n## TODO\n- Containerized Deployments Guide\n- Deployments without Downtime (Kubernetes | EKS)\n- Setup Wiki for Deployment and Documentation\n  - Exposing New APIs\n  - Building New Data Models\n  - Building New Services\n\n## Getting Started\n\n### Prerequisites\n- Go 1.21+\n- Docker\n- Docker Compose\n- RabbitMQ\n- AWS Account (for SQS integration)\n- Makefile\n\n### Installation\n1. Clone the repository:\n    ```sh\n    git clone https://github.com/singhdurgesh/rednote.git\n    cd rednote\n    ```\n\n2. Setup environment variables:\n    Create a `.env` file in the root directory and populate it with necessary environment variables.\n    ```sh\n    cp .env.example .env\n    cp configs/environments/config.docker.yaml.example configs/environments/config.docker.yaml\n    cp configs/environments/config.yaml.example configs/environments/config.local.yaml\n    ```\n\n3. Build and run the application using Docker Compose:\n    ```sh\n    docker-compose up --build\n    ```\n\n4. Run Database Migration\n     ```sh\n    make migrate\n    ```\n\n5. Verify the Application Server\n    ```sh\n    curl localhost:8080/public/ping\n    ```\n\n### Deployment\n#### Docker Setup\n- Ensure Docker and Docker Compose are installed on the deployment server.\n- Use the provided `Dockerfile` and `docker-compose.yml` for containerized deployments.\n\n#### Github Pipelines\n- Workflows are set up for CI/CD using Github Actions. Update the workflows as needed for your specific AWS EC2 deployment.\n\n### Documentation\n- Detailed documentation for API endpoints, data models, and services will be available in the Wiki section of this repository.\n\n## Contributing\nContributions are welcome! Please fork the repository and submit a pull request for review.\n\n## License\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contact\nFor any inquiries or issues, please contact [singhdurgesh403@gmail.com](mailto:singhdurgesh403@gmail.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinghdurgesh%2Frednote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsinghdurgesh%2Frednote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinghdurgesh%2Frednote/lists"}