arcana-network / demo-app

A sample full-fledged dApp that integrates with Arcana Auth and Storage SDKs. It demonstrates how any dApp can utilize Arcana Auth and Storage SDKs to build user onboarding and data privacy features quickly.

Sample Demo App: Arcana Drive

Sample Demo App

Sample Demo App demonstrates how a dApp can utilize Arcana Auth and Storage SDK for quickly onboarding dApp users and enable user data privacy.

You can access the public deployment or clone our GitHub repository to build, setup a local deployment and test drive this sample application.

💪 Key Features

• ⚙️   Integrates with Arcana Network SDKs

  • Auth SDK
  • Storage SDK

• 🗝️   Uses social authentication feature of Auth SDK to enable user onboarding via Google OAuth.

• 👛  Assigns Arcana wallet address for each authenticated user, internally. User doesn't have to necessarily set up and use a wallet explicitly.

• 🗄️   Allows dApp users to upload their data in Arcana Store for access control and privacy.

• 📂   Enables dApp users full ownership and control of their data residing in Arcana Store. Only data owners can download, share, revoke access, delete or transfer data ownership to another user.

🌐 Public Deployment

You can try out Arcana Network Drive here: https://demo.arcana.network

⚙️ Installation

Local Development

Prerequisites: You'll need an up to date node.js and npm installed in your system for this demo to work. Use LTS v16 or higher.

Clone the repository

git clone <repo-url>

Install Dependencies

• Install package dependencies

npm install

Setup Environment Variables

• Create .env file in root and copy the content of .env.example.

cp .env.example .env

Replace all variable values with actual environment variables

• To run the project in development environment

npm run dev

Build and Run

• To build the project for production (to generate static files for hosting)

npm run build

Docker: Local Development

Prerequisites:

• Docker

Clone the Repository

git clone [email protected]:arcana-network/demo-app.git

Setup Container Environment

cp .env.example .env

Build and Run

Run local environment with demo-app

make run-local

📚 Usage

Check out the Demo App Usage Guide for usage details.

For other code samples and templates to help developers speed up Arcana SDK integration, visit Code Samples section of Arcana Network documentation.

💡 Support

For any support or integration related queries, contact the Arcana Support Team.

🤝 Contributing Guide

We welcome all contributions to this public repository from the community.

Read our contributing guide to learn more about the our development process, how to propose bug fixes and improvements, and the code of conduct that we expect the participants to adhere to.

ℹ️ License

This public repository from Arcana Network is distributed under the MIT License.

For details see Arcana License.