Enhancement: Update Quickstart Guide - Githubissues

Chimoney / chimoney-community-projects

Repo for Community Contributors

http://api.chimoney.io/

MIT License

136 stars 172 forks source link

Enhancement: Update Quickstart Guide #373

Open phyleria opened 2 months ago

phyleria commented 2 months ago

Overview:

We currently lack a proper Quickstart Guide to help developers easily integrate Chimoney's API into their applications.

Update the guide with a step-by-step overview of how to get started, including:

API Key Generation: Briefly explain how to sign up and generate an API key from the developer dashboard.
SDK Installation: Provide instructions for installing Chimoney's SDK for popular languages (e.g., JavaScript). Include code snippets for each. Reference page
Making a Sample Request: Show how to make a basic API call (e.g., initiating a payout) using sample code.
Overview of Key Features: Highlight the main API functionalities such as payouts, balance retrieval, and transaction history.

Acceptance Criteria:

The page must be easy to follow, beginner-friendly, and concise.
It should include code snippets for at least two programming languages (Node.js and Python).
All instructions must be clear, accurate, and properly formatted.
Ensure all external links (e.g., API documentation) are functional.
Final submission should be in Markdown format

ifeoluwafavour commented 1 month ago

Please can i be assigned this second issue as well? I'm from WriteTechHub @phyleria

phyleria commented 1 month ago

Hi @ifeoluwafavour,

Sure! We recommend finishing your first issue before taking on a new one. Once you’re done, I’ll be happy to assign this to you. Thanks!

ifeoluwafavour commented 1 month ago

Okay. Thanks! @phyleria

phyleria commented 1 month ago

You're welcome!

DevvEmeka commented 1 month ago

@phyleria I am a member of WriteTech Hub. Can I contribute to this issue? WhatsApp Image 2024-09-30 at 19 11 37_24564dc8

phyleria commented 1 month ago

Hi @DevvEmeka

Please work on the other issues assigned and once done, I'll be happy to assign this one to you as well. Thank you!

Danbaba1 commented 1 month ago

@phyleria . I am from WriteTech hub. Can I be assigned to this issue?

Brijeshthummar02 commented 1 month ago

i can fix this, go on assign me the task.

Brijeshthummar02 commented 1 month ago

i've my soln ready can you provide me the path where to add the file. @phyleria

phyleria commented 1 month ago

Hi @Brijeshthummar02

Please submit it in the submissions folder.

phyleria commented 1 month ago

Hi @Brijeshthummar02 are you a member of Writetech Hub?

Brijeshthummar02 commented 1 month ago

no as of now i'm not a member of writetech hub, but if it req i'll be.

phyleria commented 1 month ago

Ok. Kindly join it as this issue is reserved for WriteTech Hub members only.

Brijeshthummar02 commented 1 month ago

can i get a link to it.

phyleria commented 1 month ago

Brijeshthummar02 commented 1 month ago

@phyleria i got mail, and created profile aswell, i'm now member of writetech hub. so should i go on?

phyleria commented 1 month ago

Yes, please.