Giter Club home page Giter Club logo

anansi's Introduction

Anansi

Science and Research Collection Tool

Overview

Science and research collection tool made in Electron.js and Python

Download

Coming soon...

TODO

Run python exe instead of python script in csvBackup.js (bundled/frozen via pyinstaller)

Instructions for Development

Dependencies installed via local_dev_installation_linux.sh

  • npm
  • Electron

Electron stored in node_modules, a folder created by npm install --save electron. This command is included in local_dev_installation_linux.sh

Create Electron App (Windows, Linux, MacOS)

Run each command in their respectively OS to create an executable manually (after running pyinstaller)

generate_release_build_exe.sh will bundle Python scripts and generate Electron.js executable

# Build Windows Executable
./generate_release_build_exe.sh win

# Build Linux Executable
./generate_release_build_exe.sh linux

# Build MacOS Executable 
# Not currently tested/supported

Steps

Dev Production

# Run once at the beginning to install local dependencies
./0_local_dev_installation_linux.sh

Generate and run for development (npm start vs. npm run)

npm start # To start Electron
# Note: Uncomment out 'process.env.NODE_ENV = 'production';' in main.js to show devTool options

Note: using git lfs to upload release-builds (too large for github)

git lfs track "release-builds/**"
# ** allows for recursive lfs for a folder

Errors and Solutions

Failed at the [email protected] package...


npm rebuild

# Then re-run the command

Git Large File Storage (lfs) Details

Currently, git-lfs storing links for the release-builds for Windows and Linux

$ git lfs track
Listing tracked patterns
    release-builds/** (.gitattributes)

Notes

Not tested on MacOS (npm run package-mac) Need to convert .ico to .icns for MacOS icon

Credits

Skeleton Framework
Electron Packager Scripts

anansi's People

Contributors

cyschneck avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.