Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.08 KB

README.md

File metadata and controls

71 lines (44 loc) · 2.08 KB
Raw

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 / LinkedIn / X
  2. Winful Kofi Taylor Github / LinkedIn / X
  3. Abdullah Saba Github / LinkedIn / X

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

Deployment

The application has been deployed and the production link can be found here

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
npm install

  • Create a .env that contains your environment variables. Check the .env.example file 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