Giter Club home page Giter Club logo

kaos-community-packages.github.io's Introduction

KCP-Center

What is KCP-Center?

The KCP-Center is a web site hosted on Github, that allows us to explore - in a visually pleasing way - all the existing packages in KCP, the community repository maintained by the KaOS users. The packages are classified by categories in order to facilitate the search. You can also access the descriptive meta-data of each package and view a screenshot of the app. You can access the website at: KaOS-Community-Packages.github.io

WHELP helper

To facilitate the maintenance and the updates of KCP-Center, it has created an assistant, which is a script in python called whelp that allows to keep the website synchronized with the repository of the KCP's packages. One of the possibilities allowed by whelp is to assign a category or a screenshot to any package, besides to capture its meta-data automatically. The tools git and whelp combinated allow to update the website in an easy way, such as in this example:

$ git clone https://github.com/KaOS-Community-Packages/KaOS-Community-Packages.github.io.git
$ cd KaOS-Community-Packages.github.io/helper
$ ./whelp -s
$ cd ..
$ git add .
$ git commit -am "update web"
$ git push

Important: The assistent whelp must always run inside the directory helper

Syncronize

The first thing you must do is syncronize the packages between the KCP respository and the KCP-Center. For it we run the next command:

$ ./whelp -s

Categories

To assign a category to package vscode we must run the next command:

$ ./whelp -n "vscode" -c "Development"

The categories availables are the following:

  • AudioVideo: Applications for presenting, creating, or processing multimedia (audio/video)
  • Development: Applications for development
  • Education: Educational softwares
  • Game: Games
  • Graphics: Applications for viewing, creating, or processing graphics
  • Network: Network applications such as a web browser
  • Office: Applications for office
  • Science: Scientific softwares
  • Settings: Settings applications. The entries may appear in a separate menu or as part of a "Control Center"
  • System: System applications, "System Tools" such like log viewers or network monitors
  • Utility: Small utility applications, "Accessories"

Screenshots

To assign a screenshot to package vscode we must run the next command:

$ ./whelp -n "vscode" -ss "images/screenshots/vscode.jpg"

Is important put first the image into the screenshots directory. The screenshot must be realized in jpg format and aproximatelly 550x500 px.

The screenshot's url also can be remote, like the next example:

$ ./whelp -n "vscode" -ss "http://www.parlonsgeek.com/Visual-Studio-Code.png"

Meta-data

When we update a package is necessary to update the meta-data in the kcp-center. The next example shows how to update the meta-data of the package vscode

$ ./whelp -n "vscode" -m

To update the meta-data of all KCP's packages we use the next command (it can take several minutes):

$ ./whelp  -sm

Show the package's information

If we need to know the data of the category and screenshot of a package, we use the next command (following with the example for the package vscode)

$ ./whelp -n "vscode" -i

Up the changes at Github

To update the KCP-Center in Github you must run the following commands git (in the kcp's root directory):

$ git add .
$ git commit -am "update web"
$ git push

You can test the KCP-Center locally before you commit it, by opening the file index.html in your favourite web-browser.

kaos-community-packages.github.io's People

Contributors

dagodax avatar bits4fun avatar forostm avatar bvaudour avatar loopset avatar fjmorazan avatar sixsixfive avatar martinvonreichenberg avatar alketii avatar alexmigf avatar adurol avatar shalokshalom avatar tonatiuhmira avatar astate avatar francoispascal avatar pasnox avatar demmm avatar

Stargazers

Dominique Devereaux avatar Ryan McQuen avatar Sayth avatar Cristian Fabian Bustos avatar  avatar Alberto avatar  avatar Y3R4Y avatar Colin Duquesnoy avatar  avatar  avatar

Watchers

James Cloos avatar  avatar  avatar  avatar  avatar  avatar

kaos-community-packages.github.io's Issues

More present linking to the github "source code" of a package

On the frames for the packages, a link to the github repository of the PKGBUILD may be useful for users. I was thinking of something that might look similar to this (tache used as example):

<html lang="en"><head>
    <title>KCP-center</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="description" content="KCP-center: KCP catalog of packages maintained by KaOS users">
    <meta name="keywords" content="KaOS, KaOSx, KCP, pkgbuild,user, package, linux, center, github ">
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700" rel="stylesheet" type="text/css">
    <link type="text/css" href="../css/styles.css" rel="stylesheet" media="all">
    <link type="text/css" href="../css/gh-buttons.css" rel="stylesheet" media="all">

</head>
<body style=";overflow-y:hidden;padding:40px; background-color: white;color:#222222; font-size: 14px;overflow-y:hidden;font-family: 'Open Sans', Helvetica, Arial, sans-serif;
  font-weight: 300;">
<div class="container">
    <div class="row">
           <h2 style="margin-left:-15px;margin-top:-20px;"><strong>tache </strong> 1.2-1&nbsp;&nbsp;&nbsp;&nbsp;<iframe src="https://ghbtns.com/github-btn.html?user=KaOS-Community-Packages&amp;repo=tache&amp;type=star&amp;count=true" scrolling="0" frameborder="0" height="20px" width="170px" align="middle"></iframe></h2> <hr style="margin-left:-15px;margin-top:5px;"><br><table cellpadding="10"><tbody><tr><td width="80%"><strong>description:</strong> A simple task manager in command line<br><strong>url:</strong> <a target="_blank" href="https://www.github.com/bvaudour/tache">https://www.github.com/bvaudour/tache</a><br><strong>license:</strong> 'custom'<br><strong>depends: </strong><b class="dependency-k">java-environment </b>&nbsp; <br><strong>created_at:</strong> Sunday Feb 02, 2014 at 18:40 <br><strong>pushed_at:</strong> Tuesday Feb 18, 2014 at 17:54 <br></td></tr></tbody></table>
           <div class="container-block">
            <div class=" text-center">
              <div class="well">
              <h3>How to install?</h3>
              <hr>
              <ul style="margin-left: 14px;margin-top: 15px"><strong>KCP helper</strong><br><li class="ui-state-default"><table tyle="width:100%"> <tbody><tr><td width="75%">Searching or getting the needed files from KaOS Community Packages has been simplified with the addition of the package “kcp”. You can click the button to copy the required command kcp and paste it into your console.</td><td width="5%"></td><td style="vertical-align: mid;" width="20%"><a class="btn button big" data-clipboard-text="kcp -i tache" title="click to copy to clipboard">Copy command</a></td></tr></tbody></table></li></ul>
              <ul style="margin-left: 14px"> <strong>ZIP file</strong><li class="ui-state-default"><table style="width:100%"><tbody><tr><td width="75%">Click the just downloaded package zip and extract file to your build folder. The call to start to build and install the needed dependencies is <b>makepkg -si</b>.</td><td width="5%"></td><td style="vertical-align: mid;" width="20%"><a target="_blank" href="https://github.com/KaOS-Community-Packages/tache/archive/master.zip" class="button big">Download ZIP</a></td></tr></tbody></table></li><br></ul>
              </div>
              <h3>Get the code</h3>
              <hr>
              <ul style="margin-left: 14px;margin-top: 15px">Put text here with description and <a href="https://github.com/KaOS-Community-Packages/tache">link to the github repository of packagename</a> maybe with stylish button</ul>
            </div>

    </div>
</div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.5.8/clipboard.min.js"></script>
    <script> new Clipboard('.btn');</script>

</div></body></html>

Maybe adding an additional

is overkill. A good placed button with a link would do great too.

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.