Massa icon indicating copy to clipboard operation
Massa copied to clipboard

Missing files and information

Open Benjamin-Mueggenburg opened this issue 6 years ago • 0 comments

No installation instructions make it very hard to setup. Looking a package.json, it uses react-native, meaning a react-native development environment is needed to setup, something that some people may miss.

Also it may be worth while clarifying the differences or similarities between Massa and Bassa - another one of Scorelab's projects with similar functionality.

There appears to be Unit testing or UI testing through https://flow.org/ (Flow) and https://jestjs.io/ (Jest) but there is no real instructions on how to run them (looking at package.json it's apparently npm test for jest).

Looking at files in https://github.com/scorelab/Massa/tree/master/flow-typed/npm there is still declarations that have been set to any even though at the top there is Fill this stub out by replacing all the any types.

Possible solutions:

  1. List detailed instructions on setting up the development environment, and starting the app. This will need to include setting up the react-native development environment.

  2. Have a seperate file (or in README.md) explaining the design, and functionality of Massa (a ABOUTMASSA.md page possibly) that explains in detail the purpose and how it aims to work. Regarding the similarity between it and another project (Bassa) it would be helpful to have a paragraph explaining differences and similarities and possibly how they will integrate together (as Bassa too has a mobile app)

  3. Include a separate file in the wiki or in a docs folder that has the instructions for proper development. This should include how to run proper tests, what kind of code styling to use - e.g. Google's JS style guide https://google.github.io/styleguide/jsguide.html

  4. Fill out the sub autogenerated files with the correct paths where needed

Benjamin-Mueggenburg avatar Oct 27 '18 19:10 Benjamin-Mueggenburg