{"id":29364489,"url":"https://github.com/refine-software/afrad-api","last_synced_at":"2025-07-22T14:36:42.558Z","repository":{"id":296587537,"uuid":"993845681","full_name":"refine-software/afrad-api","owner":"refine-software","description":"Afrad is a fully featured e-commerce API built by refine","archived":false,"fork":false,"pushed_at":"2025-07-08T20:58:37.000Z","size":405,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-08T21:42:46.822Z","etag":null,"topics":["docker","e-commerce","gin","golang","rest-api"],"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/refine-software.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}},"created_at":"2025-05-31T16:41:51.000Z","updated_at":"2025-07-08T20:58:41.000Z","dependencies_parsed_at":"2025-06-22T20:40:00.693Z","dependency_job_id":null,"html_url":"https://github.com/refine-software/afrad-api","commit_stats":null,"previous_names":["refine-software/afrad-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/refine-software/afrad-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refine-software%2Fafrad-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refine-software%2Fafrad-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refine-software%2Fafrad-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refine-software%2Fafrad-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/refine-software","download_url":"https://codeload.github.com/refine-software/afrad-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refine-software%2Fafrad-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264446710,"owners_count":23609630,"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":["docker","e-commerce","gin","golang","rest-api"],"created_at":"2025-07-09T11:00:15.763Z","updated_at":"2025-07-09T11:00:20.270Z","avatar_url":"https://github.com/refine-software.png","language":"Go","readme":"# Afrad API\n\nAfrad is a RESTful API for a clothing e-commerce platform. It handles user authentication, product listings, cart management, order processing, and more.\n\n---\n\n## 🚀 Get Up and Running\n\n### Prerequisites\n\n- [Docker](https://www.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n- [Goose](https://github.com/pressly/goose) (for migrations)\n- [Air](https://github.com/air-verse/air) (for development)\n- [Swag](https://github.com/swaggo/swag) (for development)\n\n### Environment Variables\n\nCreate a `.env` file with the following required environment variables:\n\n```env\n# APP\nPORT=8080\n# use 'dev' for development and 'prod' for production\nAPP_ENV=dev\nMAX_OTP_REQUESTS_PER_DAY=10\nOTP_EXP_IN_MIN=5\n\n# DB\nDB_HOST=\"afrad_db\"\nDB_PORT=5432\nDB_DATABASE=\"afrad_db\"\nDB_USERNAME=\"afrad_api\"\nDB_PASSWORD=\"afrad1020\"\nDB_SCHEMA=public\n\nDATABASE_URL=postgres://afrad_api:afrad1020@localhost:5432/afrad_db?sslmode=disable\n\n# S3\nS3_ACCESS_KEY_ID=\nS3_SECRET_ACCESS_KEY=\nS3_REGION=\nS3_BUCKET=\n\n# Oauth 2.0\nSESSION_KEY=\nGOOGLE_CLIENT_ID=\nGOOGLE_CLIENT_SECRET=\n\n# JWT\nACCESS_TOKEN_SECRET=\nACCESS_TOKEN_EXP_IN_MIN=\nREFRESH_TOKEN_SECRET=\nREFRESH_TOKEN_EXP_IN_DAYS=\n\n# Hash\nHASHING_SECRET=\n\n# Email Service\nEMAIL=\nPASSWORD=\n```\n\n### Run the Project\n\n1. **Run the API with docker**\n\n```bash\nmake docker-run # for production\nmake docker-down # for production\n\nmake docker-dev # for development\nmake docker-dev-down # for development\n```\n\n2. **Run Migrations**\n\n```bash\n# You only need to run migrations once\nmake migrate-up\n```\n\n---\n\n## 📦 API Features\n\n- User Registration (Local + OAuth)\n- Email Verification with OTP\n- Login / Logout\n- Password Reset\n- Products and Categories\n- Cart Management\n- Orders and Checkout\n- Admin Routes\n\n---\n\n## 🛠 Project Structure\n\n```\nafrad-api/\n├── cmd\n│   └── api\n├── config\n│   └── config.go\n├── docker-compose.dev.yml\n├── docker-compose.yml\n├── Dockerfile\n├── Dockerfile.dev\n├── docs\n│   ├── docs.go\n│   ├── swagger.json\n│   └── swagger.yaml\n├── go.mod\n├── go.sum\n├── internal\n│   ├── auth\n│   ├── database\n│   ├── middleware\n│   ├── models\n│   ├── s3\n│   ├── server\n│   └── utils\n├── Makefile\n├── project-docs\n│   ├── endpoints.md\n│   ├── reposConventions.md\n│   ├── schema.sql\n│   └── TODO.md\n└── README.md\n```\n\n---\n\n## 📄 License\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\nThis project is licensed under the [MIT License](LICENSE) © 2025 Refine Team.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frefine-software%2Fafrad-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frefine-software%2Fafrad-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frefine-software%2Fafrad-api/lists"}