{"id":22657377,"url":"https://github.com/adedoyin-emmanuel/agronomix-api","last_synced_at":"2025-04-12T05:09:58.190Z","repository":{"id":211678963,"uuid":"729719218","full_name":"Adedoyin-Emmanuel/agronomix-api","owner":"Adedoyin-Emmanuel","description":"Backend API for an agro based E-commerce store. ALX Specialization project","archived":false,"fork":false,"pushed_at":"2024-09-19T17:01:36.000Z","size":304,"stargazers_count":6,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T00:36:30.962Z","etag":null,"topics":["agro-api","alx-africa","alx-backend","alx-specialization"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Adedoyin-Emmanuel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-12-10T05:57:35.000Z","updated_at":"2025-02-22T04:49:27.000Z","dependencies_parsed_at":"2024-01-11T23:08:24.288Z","dependency_job_id":"e0af8c9e-04b8-481f-bdca-cee37591c716","html_url":"https://github.com/Adedoyin-Emmanuel/agronomix-api","commit_stats":null,"previous_names":["adedoyin-emmanuel/agronomix-api"],"tags_count":0,"template":false,"template_full_name":"Adedoyin-Emmanuel/nodejs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adedoyin-Emmanuel%2Fagronomix-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adedoyin-Emmanuel%2Fagronomix-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adedoyin-Emmanuel%2Fagronomix-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Adedoyin-Emmanuel%2Fagronomix-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Adedoyin-Emmanuel","download_url":"https://codeload.github.com/Adedoyin-Emmanuel/agronomix-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248519551,"owners_count":21117761,"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":["agro-api","alx-africa","alx-backend","alx-specialization"],"created_at":"2024-12-09T10:26:19.160Z","updated_at":"2025-04-12T05:09:58.157Z","avatar_url":"https://github.com/Adedoyin-Emmanuel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agronomix API 🚀\n\nThis is a agro-based ecommerce platform that allows users to buy and sell agro-based products.\n\n## The Team\n\n1.  **Adedoyin Emmanuel** [Github](https://github.com/Adedoyin-Emmanuel) / [LinkedIn](https://www.linkedin.com/in/adedoyin-emmanuel/) / [X](https://twitter.com/Emmysoft_Tm)\n2.  **Winful Kofi Taylor** [Github](https://github.com/kaytee07) / [LinkedIn](http://linkedin.com/in/winful-taylor-b1236a188) / [X]()\n3.  **Abdullah Saba** [Github](https://github.com/ayom04) / [LinkedIn](https://www.linkedin.com/in/abdullah-saba-72845a256/) / [X](https://twitter.com/AbdullahSaba9)\n\n## API Documentation\n\nThis is the documenation of the code, to know the endpoints to call with their respeective http method. All other necesaary details can be found here [API DOCS](https://documenter.getpostman.com/view/25154969/2s9YsGiDUB)\n\n## Deployment\n\nThe application has been deployed and the production link can be found [here](https://agronomix.vercel.app)\n\n## Installation Guide\n\n- To clone this project on your machine:\n\n- create a folder to clone this project both the frontend and the API\n\n**_API_**\n\n```\nhttps://github.com/Adedoyin-Emmanuel/agronomix-api.git\n```\n\n**_FRONT END_**\n\n```\nhttps://github.com/Adedoyin-Emmanuel/agronomix.git\n```\n\n- Enter the directories on your terminal using this command:\n\n```\ncd agronomix-api\n```\n\n- To install the dependencies as specified in the package.json file use:\n  We'll be using [npm](https://www.npmjs.com/)\n\n```\nnpm install\n```\n\n- Create a `.env` that contains your environment variables. Check the [.env.example file](./.env.example) to know the variables to be added.\n\n- To start the server, type this command on your terminal while you're inside the app directory:\n\n```\nnpm run dev\n```\n\n## To test the reminaing endpoints with their respective http method\n\n- While the server is up, Go to the browser and paste in this URL\n\n```\nhttp://localhost:{PORT}/api-docs\n```\n\nDon't forget to update the port to the value in your `.env`\n\n# Thanks For reading this documentation and testing it out . I hope you enjoyed the ride!\n\n\u003cbr\u003e\u003cbr\u003e\nYou can reach out to us via [mail]()\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadedoyin-emmanuel%2Fagronomix-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadedoyin-emmanuel%2Fagronomix-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadedoyin-emmanuel%2Fagronomix-api/lists"}