A list of methods and a workflow to validate, review and create reports for Hackathon projects.
Table of Contents
Create a Report for a Git project according to the workflow below.
- Get a list of the software used (name, type, link).
- Find frameworks used.
- Get the licenses for each dependency used. Are there any non-free software used without mention it?
- Search for "similar" repos (projects) on Google, GitHub, Gitlab etc (title, code pieces, funcionality, tags).
- Show commits timeline by author with visualization (use GitHub Pulse).
- Check all the required files are included (License, README with installation info, db file).
- Follow the instructions and check the project can be installed (reproduce locally).
- Check media used (eg demo images, logos etc) have a propriate license (copyright issues).
- Make a Static Code (Software) Analysis (for the main project language).
- Are there any commits during the "forced break"?
Basic characteristics to Validate (or take into consideration).
- Usage of a Framework(s)
- REST API, SDK, SOAP etc
- Responsive Design
- Administration
- Member accounts and personalization
- Documentation
- 3rd Party integrations
- Platforms available
- Consume or produce open data
- MVP status
- New and cutting edge technologies used
- Cross platform
- Database queries quality
- One page HTML
- PDF file (from HTML)
- Clone the repo locally
- Follow the installation instructions
- Check functionality, eg:
- Basic usage
- Login forms
- Console log errors
- Behavior on small screens and mobile devices
- Browser support
Git repository analysis
Offline
Online