Badge.team hatchery micropython app repository
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bootstrap
config
database
public
resources
routes
storage
tests
tmp
.codeclimate.yml
.env.example
.env.travis
.eslintrc.js
.gitattributes
.gitignore
.travis.yml
README.md
artisan
composer.json
composer.lock
package.json
phpunit-printer.yml
phpunit.xml
server.php
webpack.mix.js
yarn.lock

README.md

Badge.Team Hatchery

Build Status Maintainability Test Coverage Codacy Badge

Simple micropython software repository for Badges.

Live Site | Documentation | Project Wiki | GitHub

License

Hatchery is open-sourced software licensed under the MIT license.

The Laravel framework is open-sourced software licensed under the MIT license.

Installation

Requires PHP 7.1.3 or later!

cp .env.example .env

Edit your database, mail and other settings..

pip install pyflakes
composer install
php artisan key:generate
php artisan migrate
yarn
yarn production

Compiling and installing the patched minigzip

wget http://zlib.net/zlib-1.2.11.tar.gz
tar xvf zlib-1.2.11.tar.gz
cd zlib-1.2.11
./configure
echo -e "#define MAX_WBITS  13\n$(cat zconf.h)" > zconf.h
make
sudo make install

Running the development server.

php artisan serve

API

Apps

/eggs/get/[app]/json          - get json data for a the egg named [app]
/eggs/list/json               - a list of all eggs with description, revision etc
/eggs/search/[words]/json     - json data for search query [words]
/eggs/categories/json         - json list of categories
/eggs/category/[cat]/json     - json data for category [cat]

/basket/[badge]/list/json           - a list of all eggs for specific [badge]
/basket/[badge]/search/json         - [badge] specific search for [words]
/basket/[badge]/category/[cat]/json - json data for category [cat] on [badge]

App specific

/weather                      - weather proxied from darksky.net

Running tests

Run all the tests

phpunit

Run a test suite (for a list of availabe suites, see /phpunit.xml)

phpunit --testsuite <suite_name>

Run a specific test file

phpunit tests/<optional_folders>/TestFileName

Run a specific test case

phpunit --filter <test_case_name>

Generate code coverage

phpunit --coverage-html docs/coverage

This will create the code coverage docs in docs/coverage/index.html