This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
npm install
npm run dev
to run a dev server, ornpm run build
to compile static HTML and other assets.
- 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/
You can use npm deploy
to deploy a PodBrowser instance to Vercel, if you create an account. Alternatively, you can:
- Run
npm run build
andnpm run start
to run the node server; - Run
npm run build
andnpm run export
to export static HTML and assets to host on the server of your choice.