TactJam is a collaborative playground for composing spatial tactons. The project is split into the following repositories:
- Hardware interface: https://github.com/TactileVision/TactJam-hardware
- Firmware driving the hardware: https://github.com/TactileVision/TactJam-firmware
- GUI client to view and edit tactons: https://github.com/TactileVision/TactJam-client
- Server to store and manage tactons: https://github.com/TactileVision/TactJam-server
If you are looking for the GUI that provides information on the tactons loaded in the TactJam device, as well as document the use of a tacton, save and share it with others, you have come to the right place. Here you can find the GUI sources encapsulated in an Electron application.
The TactJam GUI is based on Node.js, React, Webpack, and Electron. The whole structure relies on npm. You can simply build and run the project with the following commands:
> npm install
> npm start
To compile the Electron app into an executable, we use the electron-builder package. You first need to build your sources using the above command, and then run > npm run compile:windows or compile:mac or compile:linux based on your OS.
You might run into an error when starting the Electron app after building or compiling it that indicates a node module was compiled against another Node version. You would then need to install the Node module electron-rebuild and run it inside the main folder to rebuild all the dependencies.
Anyone with the passion for free software is welcome to contribute to this project by:
- 👩💻 developing software
- 👾 filing any issues or suggesting new features
- 🧑🏭 sending pull requests for fixed bugs or new features
Before you start, please take a look at the project board and the issues. Maybe there is already a similar bug or feature request that is already under construction and may need your expertise and support.
In 2010 Vincent Driessen wrote a nice blog post where he introduced a branching model called git-flow. Over the years it became very popular and was used in many projects. Meanwhile GitHub introduced a much simpler workflow called GitHub flow. Both approaches have their pros and cons. That’s why we use a combination – git-flow as the branching model and the pull request workflow suggested in GitHub flow.
To make contribution easier for everyone we like use a common structure of git commit messages:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
Please refer to www.conventionalcommits.org for more information.
This might not be the world’s largest code base. However, a consistent code style makes it easier to read and maintain. The people at Google are very experienced in this and have published their guidelines for different languages. For this project we want to orientate ourselves by this (e.g. C++ style guide for firmware code).
TactJam-client is (C) 2020 Tactile Vision
It is licensed under the MIT license. For details, please refer to the LICENSE file.