Svelte Component Center - v2

Overview

This project is the frontend for the guest and operator-facing portals.

Routing

When adding a new page, please respect the routings found here: https://www.notion.so/peeet/URLs-and-paths-20fdd4a4d25c8042bb8ffc5f7c45d596?source=copy_link

Contributing

# checkout the latest main branch
git checkout main
# if you get an error about pending changes, either commit and push or run git stash
git pull
git checkout -b <yourname>/<featurename>
# do your work, when ready to deploy to a test environment:
git add *
git commit -m "add message here"
git push -u origin <yourname>/<featurename>

Then, open up a Pull Request here: https://github.com/get-micdrop/micdrop-frontend/pulls

When your pull request is created, a deployment job will automatically be generated to deploy on to vercel. Example: https://github.com/get-micdrop/micdrop-frontend/pull/1

Installation

To set up the project, install the dependencies using either of the following commands:

# create a new project in the current directory
npm install

# create a new project in my-app
yarn install
# or
yarn

To start the development server, run:

npm run dev
# or
yarn dev

The server will be available at http://localhost:5173/.

Storybook Integration

To view and interact with the components in a Storybook environment, execute the following command:

npm run storybook
# or
yarn storybook

Storybook will be available at http://localhost:6006/.