Skip to content

Latest commit

 

History

History
133 lines (100 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

133 lines (100 loc) · 3.86 KB

Setup Guide for Windows and Linux

Before getting started, ensure you have:

  • A Windows/Linux system with administrative access
  • Internet connectivity

⚙️ Steps to setup cpp-sdk-appwrite on Windows

  • Install Chocolatey, a package manager for Windows, as it simplifies software installation process.

  • Install mingw using chocolatey.

    choco install mingw

  • This will install and set mingw paths in windows system.

  • Now, we'll need Curl, ofcourse. Go to Official Curl Website and download the latest binary builds for your desired 64/32bit OS and extract the folder (any location).

  • Press Win + R, type sysdm.cpl, and press Enter to open System Properties.

  • Go to the Advanced > Environment Variables.

    Under System variables

    • Click "New..." to add CPLUS_INCLUDE_PATH.

        Variable name: CPLUS_INCLUDE_PATH

  Variable value: C:\path\to\curl\include (Replace with actual include folder path)

    • Click "New..." to add LIBRARY_PATH.

        Variable name: LIBRARY_PATH

  Variable value: C:\path\to\curl\lib (Replace with actual lib folder path)

    • Click "New..." to add CURL_CERT.

        Variable name: CURL_CERT

  Variable value: C:\path\to\curl\bin\curl-ca-bundle.crt (Replace with actual bin folder path)

    Find the Path variable and click "Edit...".

    Click "New" and add

      C:\path\to\curl\bin (Replace with actual bin folder path).

  • Ensure it's added as a new, separate entry. Click "OK" on all dialogs to save the changes.

    Important: You might need to restart open command prompts/IDEs for the changes to take effect.

  • Go to Github and Fork the repository

  • Clone your forked repository:

    git clone https://github.com/<your-github-username>/cpp-sdk-appwrite.git

  • Navigate to the project directory:

    cd cpp-sdk-appwrite

  • Now let's try compiling an API to check if the setup is ready.

    mingw32-make testSDK

  • You should see a folder "/tests" will be created signalling the successfull setup of the project.

  • Execute the compiled binary

    cd tests
./testSDK

    You should see the output as

    Setup Complete. Welcome to cpp-sdk-appwrite!!!

⚙️ Steps to setup cpp-sdk-appwrite on Linux

  • Install dependencies and build-essentials

    sudo apt-get update
sudo apt-get install build-essential clang-format
pip install pre-commit
pre-commit install

  • Go to Github and Fork the repository

  • Clone your forked repository:

    git clone https://github.com/<your-github-username>/cpp-sdk-appwrite.git

  • Navigate to the project directory:

    cd cpp-sdk-appwrite

  • Now let's try compiling an API to check if the setup is ready.

    make testSDK

  • You should see a folder "/tests" will be created signalling the successfull setup of the project.

  • Execute the compiled binary

    cd tests
./testSDK

    You should see the output as

    Setup Complete. Welcome to cpp-sdk-appwrite!!!

  • Create a new branch for your contribution:

How to Contribute ?

After you're done with setting up cpp-sdk-appwrite you can create new APIs in the subsequent classes and raise PR for the feature/bug in develop branch.

  • Create a new branch for your contribution:
git checkout -b feat/<feature-name>
  • Make your changes, squash the commits and commit it with a valid commit message :
git commit -m "feat:added api for sms [messaging]"
  • Push your changes to your fork:
git push origin feat/<feature-name>
  • Raise a Pull Request to the develop branch.
  • Get your PR merged! 🚀