Skip to content

This is the rework of the current Frontend at shocklink.net, for controlling shock collars over the internet.

License

Notifications You must be signed in to change notification settings

OpenShock/Frontend

Repository files navigation

OpenShock Frontend

Documentation GitHub license GitHub Releases GitHub Sponsors Discord

master Build Status

This is the frontend for the OpenShock project that interfaces with the OpenShock API.

Technologies

Typescript Vite SveltKit Skeleton UI Tailwind CSS

Setup

To get started with development, you will need to have Node.js LTS installed.

We recommend using a version manager like Volta to manage your Node.js versions. Alternatively, you can use nvm-linux or nvm-windows.

If you are going to update the OpenAPI schema, you will need to have Java installed to run the OpenAPI generator.

After you have Node.js installed, you can run the following commands to get started:

npm i
npm run dev

Available Commands

  • npm i - Install dependencies
  • npm run dev - Start the development server
  • npm run build - Build the project
  • npm run preview - Preview the built project
  • npx openapi-generator-cli generate - Generate the API client

About

This is the rework of the current Frontend at shocklink.net, for controlling shock collars over the internet.

Topics

Resources

License

Stars

Watchers

Forks