Skip to main content

Introduction

Welcome to the Borku Africa Developer Documentation. This documentation is designed to help you understand the Borku Africa API and how to use it.

Important things to note​

  • Borku Africa is built using Appwrite as its backend. Appwrite is an open-source backend server that helps you build secure and scalable applications. Learn more about Appwrite here.
  • Appwrite's syntaxes are very similar across all its SDKs. This means that if you are familiar with one SDK, you can easily work with another SDK. For this documentation, we will be using the web SDK, but you can easily switch to another SDK if you are more comfortable with it or depending on the project and platform you are working on.
  • Borku Africa is an e-commerce platform with 3 apps: the admin console, the vendors app, and the customer app. Each app has its own set of features and functionalities. This documentation will guide you on how to use the Borku Africa API to build on top of these apps.
  • All the API keys, endpoints and variables are in a .env file which is securely shared with you. Please do not share this file with anyone else. The variable names used are the same as the ones in the .env file. If you have any questions or need help, please reach out to us.
  • All the code provided are basic but functional codes. You can implement them with your own logic and preferred state management solution