https://github.com/osteele/poseshare

https://github.com/osteele/poseshare

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/osteele/poseshare
• Owner: osteele
• License: mit
• Created: 2022-05-01T06:18:43.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-20T12:44:03.000Z (over 2 years ago)
• Last Synced: 2025-02-25T09:18:40.276Z (over 1 year ago)
• Language: TypeScript
• Size: 445 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# PoseShare

Share pose detection data between multiple browser clients connected to the same

server.

This code supports of the Movement Practices choreography project.

The client and server are written in Typescript. They use the

[Socket.IO](https://socket.io) library to communicate.

## Setup

Install npm.

Run `yarn install`.

## Usage

1. Run `yarn dev`.

2. Use a web browser to visit .

## Development

### Client development

Set up and start the server as above.

The server will restart when source files are changed.

The browser page needs to be manually reloaded.

### Server development

Additional development documentation is in this repository's `docs/` directory,

and the [project wiki](https://github.com/osteele/PoseShare/wiki/).

### Directory Organization

Subdirectories:

- `common/` — source files that are shared between the client and server

- `config/` — configuration files for the client and server

- `public/` — static files that are served by the embedded web server

- `server/` — TypeScript source code for the http (web and API) server

- `src/` — TypeScript source code for client

Top-level files:

- `index.html` — static file that is served by the embedded web server

- `nodemon.json` — [Nodemon](https://nodemon.io) configuration file

- `package.json` — an npm

  [package](https://docs.npmjs.com/cli/v6/configuring-npm/package-json), that

  specifies library dependencies, build tools, and the build and development

  commands.

The client source directory is named `src` instead of `client`, so that it will

work with the default configuration of Vite.

## License

Copyright 2022 by Oliver Steele. Available under the MIT License.