Giter Club home page Giter Club logo

synopackage's Introduction

README

What is this repository for?

This is source code for page https://search.synopackage.com. It is a search engine for third-party packages dedicated to Synology's DSM system.

How do I get set up?

  • Installation

    • clone the repository
    • install composer (if not installed already)
    • in terminal type: cd src && composer install
  • Configuration

    • All configuration files are included in "conf" folder
  • Dependencies

    • Mustache >= 2.5
    • symfony/yaml 3.3
    • monolog/monolog 1.23
    • autoload
    • PHP 7.1 (may be probably downgraded, however not tested)
    • phpunit/phpunit 6.3.0
  • Database configuration

    • This is database-less application
  • How to run tests

    • call "phpunit" in main folder
    • with html code coverage: "phpunit --coverage-html src/clover" (or other folder)
  • Deployment instructions

    • Copy all files from "src" folder www root folder or www sub-folder
    • Create "cache" folder and make sure it is writeable

Contribution guidelines

  • Writing tests
    • create "cache" folder in root directory (if not exists already) - it's mandatory for tests
    • run tests before develop feature
    • develop feature and add new tests
    • run tests after development
    • if tests passed then commit
  • Code review
    • I'm a single developer, so there is no code review (for now)
  • Other guidelines
    • Just keep the current architecture

Who do I talk to?

  • Repo owner or admin
    • See my profile details
  • Other community or team contact
    • None (for now)

synopackage's People

Contributors

szyb avatar

Watchers

12345 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.