https://github.com/cloudydaiyz/stringplay-ui

Frontend for the stringplay project
https://github.com/cloudydaiyz/stringplay-ui

Last synced: about 1 month ago
JSON representation

Frontend for the stringplay project

• Host: GitHub
• URL: https://github.com/cloudydaiyz/stringplay-ui
• Owner: cloudydaiyz
• Created: 2024-10-06T14:38:37.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-12-05T05:03:52.000Z (2 months ago)
• Last Synced: 2024-12-05T05:23:06.882Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.64 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        








stringplay-ui





stringplay is an event analytics service that collects aggregate membership data from your events, allowing you to effectively track event and membership data. Based on membership-logger.



## Overview

This repository provides the frontend for the stringplay project. For other relevant repositories, check out the following links:

- [`stringplay`](https://github.com/cloudydaiyz/stringplay) (Main)

- [`stringplay-core`](https://github.com/cloudydaiyz/stringplay-core) (Backend)

## Installation

Make sure that Node.js version 20.0.0 or higher is installed on your device. 

1. Run `npm install` to install dependencies for the root package.

2. Run `npm run build` to build static files in the `/dist` directory which serves files at the root directory (`/`).

## Environment Variables

- `VITE_STRINGPLAY_CORE_URL` - URL for the backend

## Commands

- `npm run dev`: Runs development server in Vite. Backend functionality is **NOT** mocked.

- `npm run build`: Transpiles all `.ts` code and builds source files in the `/dist` folder

- `npm run lint`: Runs `eslint` linter on the project

- `npm run storybook`: Runs a local storybook server to preview all components. Backend functionality is mocked.

- `npm run build-storybook`: Builds the code necessary for storybook to run