Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.54 KB

README.md

File metadata and controls

61 lines (38 loc) · 1.54 KB

Dansdata.se Portal

An administration interface for managing API keys and data presented via the dansdata API.

Getting Started

The project utilizes a devcontainer with most dependencies, including supabase-cli, already included.

The administration portal is based on next.js and uses supabase as its backend.

First, start your local supabase backend:

supabase start

Take note of the API URL and anon key. Add these to your local .env.local file at the repository root:

NEXT_PUBLIC_SUPABASE_URL=<your-supabase-api-url>
NEXT_PUBLIC_SUPABASE_ANON_KEY=<your-anon-key>

Finally, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Supabase

The portal uses supabase as its backend. For more details on local development using supabase, please see the official guide.

Storybook

Components are documented using Storybook.

You can view this documentation by running

npm run storybook

Stories should be located next to their respective components in a [component].stories.(mdx|tsx) file.

About Dansdata.se

Dansdata (lit. "dance data") is an open API for information relating to social dancing in Sweden.

Felix Zedén Yverås is the project's current maintainer.

License

MIT