SimpleScout
An FRC scouting program written in node.js and powered by The Blue Alliance API and the FIRST API
Dependencies
Please note that these are just working dependencies. I don't actually know how many of these will be used in final release. Looking at the code, its obvious that some of these are not used or used very sparingly.
q npm install q
sync-prompt npm install sync-prompt
underscore.js npm install underscore
(May not make final release)
read-file npm i read-file --save
xlsx.js npm install xlsx
plotly npm install plotly
(May not make final release)
python-shell npm install python-shell
(may not make final release)
plotly pip install plotly
(may not make final release)
mkdirp npm install mkdirp
pygal pip install pygal
##Instructions
Currently still under development, so no solid instructions yet.
##Known Bugs/Issues
- Sometimes not all the data is received but the calculations are still done. Just running the program again usually fixes the issue.
- There is no validation at this point to determine if the team number is actually valid. Entering a non-existant team or a team in the wrong format will throw a nasty error
- You will require an
authkey
ortoken
in order to run the complex version of the code. You can request one here
##Goals/Future Work
I am a novice when it comes to asynchronous functions and js in general. If anybody would like to help clean up the code and make more efficient, I would really appreciate it. None the less, I will be developing this project throughout the year to ensure that it is in its best shape for the 2016 season. The following features are tentatively being thought about:
- Validation in all aspects of the code
- Making asynchronous functions work better with each other
- Creating a filter for the matches analyzed/reviewed
- Creating a website or phone app for easier access
- Display more detailed status using the FIRST API
- Do all async work using promises
- Make an index/api
##Updates
- 5/1/2015: (Finally) Gained access to the FIRST api and began development on a more concise scouting system
- 5/2/2015: Basic functionality for scraping team data from the FIRST api is complete (much more data gathered than from the blue alliance)
- 5/5/2015: Began working on bulk data entry (excel) and auto generation of excel files
- 5/7/2015: Began working on the graphs and other analytics
- 5/8/2015: Looking into python for plotting data instead of using node.js (want to locally generate graphs)
- 5/16/2015: Began working with q promises in order to make the data generation more predictable
##Conclusion/Notes Please feel free to contribute and send pull requests. If you have any problems or find a bug, please rasise an issue. This project is being actively developed on behalf of FRC 1923: The Midknight Inventors