Arcana Network Developer Dashboard

⚙️ Arcana Developer Dashboard

Arcana Developer Dashboard allows dApp developers to configure how they choose to integrate and use Arcana SDKs. It is used to tailor the desired dApp user experience for authentication, data privacy, storage access, and monitoring dApp user storage consumption metrics.

⚠️ Caution: Arcana Network SDKs and apps (Beta Release), not recommended for production usage.

💪 Key Features

⛓️   Register your dApp with Arcana Network and select storage region for dApp user data

🔒   Configure social authentication, passwordless login to onboard dApp users

👛   Specify Storage usage and bandwidth limit per dApp user

⚙️   Configure transaction signing user experience (no UI, popup UI) as per dApp use case

📚 Documentation

Check out Arcana Network documentation and refer to How to Register and Configure dApp Guide for details.

💡 Support

For any support or integration related queries, contact Arcana support team.

🤝 Contributing

We welcome all contributions to the Arcana Developer Dashboard from the community. Read our contributing guide to learn about our development process, how to propose bug fixes and improvements, and the code of conduct that we expect the participants to adhere to. Refer to the development section of this readme for details on how to build and validate your changes to the Developer Dashboard code before submitting your contributions.

ℹ️ License

Arcana Developer Dashboard is distributed under the MIT License.

For details see Arcana License.

🚀 Development and Setup

For local development, start by cloning the repository.

git clone git@github.com:arcana-network/developer-dashboard.git

Move to the project directory.

cd developer-dashboard

Ensure you have node version v16 or higher installed. Install project dependencies.

npm install

In the project root, create an .env file by copying the content of .env.example, and filling in the environment variables.

cp .env.example .env

🧪 Build and Test

Start the local development server.

npm run dev

Run all linters and formatters.

npm run lint

Build and generate static files for production.

npm run build

Preview the generated site before deploying.

npm run preview

🫙 Docker Setup

If you'd like to use Docker to setup the dashboard as a service, follow the above quick start steps and then use

make run-local

to spin up the service.