{"id":18599337,"url":"https://github.com/bkawk/go-echo","last_synced_at":"2025-11-02T08:30:24.802Z","repository":{"id":106274149,"uuid":"597380526","full_name":"bkawk/go-echo","owner":"bkawk","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-19T09:32:40.000Z","size":285,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-26T22:18:40.592Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bkawk.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":"2023-02-04T11:21:28.000Z","updated_at":"2023-02-04T13:25:28.000Z","dependencies_parsed_at":"2023-04-01T02:17:46.652Z","dependency_job_id":null,"html_url":"https://github.com/bkawk/go-echo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkawk%2Fgo-echo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkawk%2Fgo-echo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkawk%2Fgo-echo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkawk%2Fgo-echo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bkawk","download_url":"https://codeload.github.com/bkawk/go-echo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239389582,"owners_count":19630309,"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":[],"created_at":"2024-11-07T01:38:43.805Z","updated_at":"2025-11-02T08:30:24.768Z","avatar_url":"https://github.com/bkawk.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Go-Echo Boilerplate API\n\nA pre-built REST API project that combines Go and the Echo framework to provide a simple yet robust foundation for developers.\n\n## Introduction\n\nGo-Echo Boilerplate API is designed to be a fast and efficient solution for building RESTful APIs. The [Echo](https://echo.labstack.com/)  framework is known for its performance, scalability, and ease of use. With this boilerplate, you can take advantage of Echo's lightning-fast routing and middleware support to build APIs that can handle large amounts of traffic with ease. Whether you're building a high-performance application or just need to get up and running quickly, Go-Echo provides a foundation that is both fast and reliable. By leveraging the power of Go and the Echo framework, you can ensure that your API will perform at peak efficiency and provide a smooth experience for your users.\n\n## Key Features\n\n- User authentication and authorization\n- MongoDB Atlas integration\n- Rate limiting\n- Body size limit\n- Secure middleware\n- CORS support\n- Email verification\n- Password reset\n\n## Requirements\n - Go\n - Echo\n - MongoDB Atlas\n - SMTP Server (e.g. Gmail, SendGrid, etc.)\n\n## Getting Started\n\n1. Clone this repository\n2. Make sure you have Go installed on your machine\n3. Set up a MongoDB Atlas cluster and obtain your connection string\n4. Create a .env file in the root of the project and add the following variables:\n\n\n - PORT: The port on which the server will run, e.g. :8000\n - MONGO_URL: The connection string for your MongoDB Atlas cluster, e.g. mongodb+srv://\u003cusername\u003e:\u003cpassword\u003e@cluster0.mongodb.net/test?retryWrites=true\u0026w=majority\n \n - MONGO_DB: The name of the database, e.g. databaseName\n - BCRYPT_PASSWORD: The bcrypt password, e.g. bcryptPassword\n - EMAIL_FROM: The email address from which emails will be sent, e.g. my@email.com\n - SMTP_SERVER: The SMTP server used for sending emails, e.g. smtp.example.com\n - SMTP_PORT: The port used for the SMTP server, e.g. 587\n - SMTP_PASSWORD: The password for the SMTP server, e.g. password\n - JWT_SECRET: The secret used for signing JSON Web Tokens (JWT), e.g. jwtSecret\n - VERIFY_URL: The URL used for email verification, e.g. http://example.com/verify\n - RESET_EMAIL_URL: The URL used for resetting the email, e.g. http://example.com/reset-email\n\n\n5. Run the following command to install the dependencies:\n\n``` go get ```\n\n6. Run the following command to start the server:\n\n``` go run main.go  ```\n\n## Endpoints\n - [Health Check](health.md): GET /health\n - [Check username availability](username_availability.md): GET /username/:username\n - [Register](register.md): POST /register\n - [Login](login.md): POST /login\n - [Verify Email](verify_email.md): GET /verify-email? verificationCode=\u003cverificationCode\u003e\n - [Resend Verification Email](resend_verification.md): POST /resend-verification\n - [Reset Password](password_reset.md): POST /reset-password\n - [Refresh Token](refresh_token.md): POST /refresh\n - [Invalidate Refresh Token](invalidate_token.md): DELETE /refresh\n \n - [Update Profile](update_profile.md): PUT /profile ***\n - [Retrieve Profile](retrieve_profile.md): GET /profile/:user_id ***\n\n## How to Contribute\nIf you would like to contribute to the project, please follow these steps:\n\n1. Fork the repository\n2. Create a new branch for your contribution\n3. Commit your changes to the new branch\n4. Submit a pull request to the original repository\n5. We welcome all contributions, including bug fixes, new features, and documentation 6. improvements. Thank you for your support!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkawk%2Fgo-echo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbkawk%2Fgo-echo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkawk%2Fgo-echo/lists"}