https://github.com/adedoyin-emmanuel/agronomix-api
Backend API for an agro based E-commerce store. ALX Specialization project
https://github.com/adedoyin-emmanuel/agronomix-api
agro-api alx-africa alx-backend alx-specialization
Last synced: 21 days ago
JSON representation
Backend API for an agro based E-commerce store. ALX Specialization project
- Host: GitHub
- URL: https://github.com/adedoyin-emmanuel/agronomix-api
- Owner: Adedoyin-Emmanuel
- Created: 2023-12-10T05:57:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-19T17:01:36.000Z (8 months ago)
- Last Synced: 2025-03-26T00:36:30.962Z (about 1 month ago)
- Topics: agro-api, alx-africa, alx-backend, alx-specialization
- Language: TypeScript
- Homepage:
- Size: 297 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agronomix API 🚀
This is a agro-based ecommerce platform that allows users to buy and sell agro-based products.
## The Team
1. **Adedoyin Emmanuel** [Github](https://github.com/Adedoyin-Emmanuel) / [LinkedIn](https://www.linkedin.com/in/adedoyin-emmanuel/) / [X](https://twitter.com/Emmysoft_Tm)
2. **Winful Kofi Taylor** [Github](https://github.com/kaytee07) / [LinkedIn](http://linkedin.com/in/winful-taylor-b1236a188) / [X]()
3. **Abdullah Saba** [Github](https://github.com/ayom04) / [LinkedIn](https://www.linkedin.com/in/abdullah-saba-72845a256/) / [X](https://twitter.com/AbdullahSaba9)
## API Documentation
This 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)
## Deployment
The application has been deployed and the production link can be found [here](https://agronomix.vercel.app)
## Installation Guide
- To clone this project on your machine:
- create a folder to clone this project both the frontend and the API
**_API_**
```
https://github.com/Adedoyin-Emmanuel/agronomix-api.git
```
**_FRONT END_**
```
https://github.com/Adedoyin-Emmanuel/agronomix.git
```
- Enter the directories on your terminal using this command:
```
cd agronomix-api
```
- To install the dependencies as specified in the package.json file use:
We'll be using [npm](https://www.npmjs.com/)
```
npm install
```
- Create a `.env` that contains your environment variables. Check the [.env.example file](./.env.example) to know the variables to be added.
- To start the server, type this command on your terminal while you're inside the app directory:
```
npm run dev
```
## To test the reminaing endpoints with their respective http method
- While the server is up, Go to the browser and paste in this URL
```
http://localhost:{PORT}/api-docs
```
Don't forget to update the port to the value in your `.env`
# Thanks For reading this documentation and testing it out . I hope you enjoyed the ride!
You can reach out to us via [mail]()