Skip to content

zimm0x/examples-hub

 
 

Repository files navigation

Para Examples Hub

Welcome! This repository is a central collection of example applications demonstrating various ways to integrate and use the @getpara/* suite of SDKs and packages across different platforms and frameworks.

Whether you're building a web app, mobile app, backend service, or something more specialized, you can browse these examples to find patterns and integration guides.

Repository Structure

The examples are organized into top-level directories based on the primary platform or environment:

  • /web: Contains examples for web application frontends.
    • These are further subdivided by framework and/or bundler (e.g., /web/with-react-nextjs, /web/with-react-vite, /web/with-svelte-vite).
  • /mobile: Contains examples for mobile applications.
    • These are further subdivided by platform or framework (e.g., /mobile/with-expo, /mobile/with-react-native, /mobile/with-flutter).
  • /server: Contains examples for server-side or backend applications.
    • These are further subdivided by runtime or framework (e.g., /server/with-node, /server/with-bun, /server/with-deno).
  • /specialized: Contains examples for specific use cases, integrations, or less common platforms.
    • Examples include integrations with Electron.js, Telegram Web Apps, specific DeFi protocols, etc. (e.g., /specialized/with-electronjs, /specialized/with-jupiter-dex-api).

Each specific example (e.g., /web/with-react-nextjs/para-modal) lives within its own directory and aims to be self-contained with its own dependencies and configuration.

Getting Started with an Example

Most examples are designed to be run independently. Follow these general steps:

  1. Clone the Repository:

    git clone [https://github.com/getpara/examples-hub.git](https://github.com/getpara/examples-hub.git)
    cd examples-hub
  2. Navigate to an Example: Change directory into the specific example you are interested in:

    # Example: Navigate to the Para Modal example using React + Next.js
    cd web/with-react-nextjs/para-modal
  3. Install Dependencies: Use Yarn (which is primarily used in this repository) to install the example's specific dependencies. Check the example's own README if a different package manager is required (e.g., flutter pub get for Flutter).

    yarn install
  4. Configure Environment Variables: Many examples require API keys, RPC URLs, or other configuration settings. Look for a .env.example, config.example.ts, or similar file within the example's directory. Copy it to a new file (e.g., .env) and populate it with your specific values.

    # Example using .env
    cp .env.example .env
    # Now edit .env with your values using your preferred editor
    nano .env
  5. Run the Example: Each example directory should contain its own README.md with specific instructions on how to run it (e.g., yarn dev, yarn start, expo start, flutter run). Please refer to those instructions.

Support

If you encounter issues with a specific example or have questions about using the @getpara/* SDKs demonstrated here, please reach out to us directly at support@getpara.com.


Happy Building!

About

A feature specific scaffold for various frameworks interacting with Capsule SDKs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 67.4%
  • C 7.5%
  • C++ 7.4%
  • Dart 6.5%
  • CMake 3.8%
  • Swift 3.2%
  • Other 4.2%