Skip to content

StatWrap - a free and open-source assistive, non-invasive discovery and inventory tool to document research projects

License

Notifications You must be signed in to change notification settings

StatTag/StatWrap

 
 

Repository files navigation

StatWrap

CI Status

This project was quickly brought up to speed thanks to the electron-react-boilerplate project.

Development Environment

StatWrap is built using Electron, which allows cross-platform compiling and deployment. Electron provides instructions on setup which are not duplicated here, but briefly requires you to have Node.js and NPM available.

You will also need to have Yarn installed for package management. Yarn provides several installer options across operating systems.

Once all of the core system dependencies are installed, go to the StatWrap root directory and use yarn to install all of the packages:

yarn

To run all unit tests:

yarn test

To run the Electron app in the dev environment (which includes hot updates as you make changes):

yarn dev

When you are ready to build a version of the app for deployment, you can run:

yarn package

About

StatWrap - a free and open-source assistive, non-invasive discovery and inventory tool to document research projects

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 10