solid/pod-browser

PodBrowser

A modular tool to view, manage, and control access to your Pod.

Code of Conduct · [Documentation] · [Support]

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

Installation

1. npm install
2. npm run dev to run a dev server, or npm run build to compile static HTML and other assets.

Development

• PodBrowser uses a framework called Next.js, which has extensive documentation. It uses React for client-side templates, Webpack for building assets, and Jest for tests.
• Any environment variables you wish to expose must be added to next.config.js.
• When making commits, follow the guidelines outlined in this post: https://cbea.ms/git-commit/

Deployment

You can use npm run deploy to deploy a PodBrowser instance to Vercel, if you create an account. Alternatively, you can:

• Run npm run build and npm run start to run the node server;
• Run npm run build and npm run export to export static HTML and assets to host on the server of your choice.