diff --git a/.coafile b/.coafile new file mode 100644 index 00000000..6dc90310 --- /dev/null +++ b/.coafile @@ -0,0 +1,14 @@ +[html] +bears = HTMLLintBear +files = **.html +htmllint_ignore = indentation, optional_tag, concerns_separation, capitalization + +[js] +bears = JSHintBear +files = **.js +ignore = **.min.js, **/lib/**, bootstrap/**, _site/** + +[css] +bears = PHPCodeSnifferBear +files = **.css +ignore = **.min.css, bootstrap/**, _site/** diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..441f8f2e --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.idea/ +.settings/ +_site/ +Gemfile.lock diff --git a/.settings/.jsdtscope b/.settings/.jsdtscope deleted file mode 100755 index 80e81fd7..00000000 --- a/.settings/.jsdtscope +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/.settings/org.eclipse.wst.jsdt.ui.superType.container b/.settings/org.eclipse.wst.jsdt.ui.superType.container deleted file mode 100755 index 3bd5d0a4..00000000 --- a/.settings/org.eclipse.wst.jsdt.ui.superType.container +++ /dev/null @@ -1 +0,0 @@ -org.eclipse.wst.jsdt.launching.baseBrowserLibrary \ No newline at end of file diff --git a/.settings/org.eclipse.wst.jsdt.ui.superType.name b/.settings/org.eclipse.wst.jsdt.ui.superType.name deleted file mode 100755 index 05bd71b6..00000000 --- a/.settings/org.eclipse.wst.jsdt.ui.superType.name +++ /dev/null @@ -1 +0,0 @@ -Window \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..e29dc2c3 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,16 @@ +language: ruby +rvm: + - 2.3.3 +services: docker +install: + - bundle install +script: + - bundle exec jekyll build + - bundle exec htmlproofer ./_site + - touch .gitignore + - > + docker run --volume=$(pwd):/app --workdir=/app coala/base:0.9 /bin/bash -c + "coala --non-interactive" +branches: + only: + - gh-pages diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..bbe0e0a9 --- /dev/null +++ b/Gemfile @@ -0,0 +1,5 @@ +source "https://rubygems.org" + +gem "jekyll" +gem "github-pages" +gem "html-proofer" diff --git a/README.md b/README.md new file mode 100644 index 00000000..d34b5245 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# susper.com + +Susper is a decentral Search Engine that uses the peer to peer system yacy and Apache Solr to crawl and index search results. + +[![Build Status](https://travis-ci.org/fossasia/susper.com.svg?branch=gh-pages)](https://travis-ci.org/fossasia/susper.com?branch=gh-pages) +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2ba119419e7444b3b505bb37b4525deb)](https://www.codacy.com/app/shiven15094/susper-com?utm_source=github.com&utm_medium=referral&utm_content=fossasia/susper.com&utm_campaign=Badge_Grade) +[![Code Climate](https://codeclimate.com/github/fossasia/susper.com/badges/gpa.svg?branch=gh-pages)](https://codeclimate.com/github/fossasia/susper.com) +[![codecov](https://codecov.io/gh/fossasia/susper.com/branch/gh-pages/graph/badge.svg)](https://codecov.io/gh/fossasia/gh-pages) +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/fossasia/susper.com?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +##Communication + +Our chat channel is on gitter here: https://gitter.im/fossasia/susper.com + +## Components and Technology + +This is a search front-end for YaCy. Retrieval of search results using YaCys search API and display using AJAX technology. + +* Solr, JSON(P) and JavaScript / backbone.js - driven + +Search results are displayed using AJAX-technology from a Solr server which is embedded into YaCy. All search results must be provided by a YaCy search server which includes a Solr with a specialized JSON result writer. When a search request is made in one of the search templates, a http request is made to YaCy. The response is done in JSON because that can much better be parsed than XML in JavaScript. To overcome the same orgin policy in JavaScript, the result is capsuled into a JSONP response. This enables you to run YaCy anywhere and to use the results from this server somewhere else, maybe in static web pages, even from a file system. We implemented a proper model view of search results using the MV*-Fra­me­work backbone.js. + +* Industry-Strength Search Efficiency + +Because the search results come right from a Solr instance using a specialized result writer, these templates can provide industry-strength search portals. This is an unique combination of Solr, JSON(P), flexible JavaScript presentation the beautiful YAML4 CSS Framework and the easiness of web index creation with YaCy. + +* Standard Compliance + +There are standards for search request queries (i.e. SRU) and search request responses (i.e. opensearch). YaCy provides both! Actually these search templates send SRU requests to YaCy and the jsonp result writer in Solr (inside YaCy) returns a into-JSON transformed version of openseach. If you like, then you can also get search results from the same query url by replacing the "wt=yjson"-parameter by "wt=opensearch". + +* Beautiful CSS Framework + +These pages are made with the YAML4 CSS Framework and it will serve you very well for the creation of own search portals. Just use the template as provided in the git repository (see below: 'Clone This!') and create your own search portal. + +## Installation + +### How do I install on a Server + +Please check out [the documentation here](/docs/INSTALLATION.md). + +### How do I install on my local machine + +Please check out [the documentation here](/docs/INSTALLATION_LOCAL.md). + +### How do I install on Google Cloud + +To install the system on Google Cloud please refer to the [Google Cloud installation readme](/docs/INSTALLATION_GOOGLE.md). + +#### How do I install on AWS + +To install the system on AWS please refer to the [AWS installation readme](/docs/INSTALLATION_AWS.md). + +#### How do I install on Digital Ocean + +To install the system on Digital Ocean please refer to the [Digital Ocean installation readme](/docs/INSTALLATION_DIGITALOCEAN.md). + +#### How do I deploy Web App Generator with Heroku + +Please read how to deploy to [Heroku here](/docs/INSTALLATION_HEROKU.md) + + +## Contributions, Bug Reports, Feature Requests + +This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. Please report issues here https://github.com/fossasia/susper.com/issues + + +## Issue and Branch Policy + +Before making a pull request, please file an issue. So, other developers have the chance to give feedback or discuss details. Match every pull request with an issue please and add the issue number in description e.g. like "Fixes #123". + +We have the following branches + * **development** + All development goes on in this branch. If you're making a contribution, + you are supposed to make a pull request to _development_. + PRs must pass a build check and unit-tests check on Travis + * **gh-pages** + This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update, and make a release. + + +## LICENSE + +The repository is licensed under Creative Commons Attribution 2.0 License (CC-BY 2.0). + +## Maintainers + +The project is maintained by +* Michael Christen ([@Orbiter](https://github.com/Orbiter)) +* Mario Behling ([@mariobehling](http://github.com/mariobehling)) + diff --git a/css/base.css b/css/base.css index fc18d78b..7dd0a55f 100644 --- a/css/base.css +++ b/css/base.css @@ -46,6 +46,7 @@ dl { body, table, textarea { font-size: 12px; + overflow-x: hidden; } h1, h2, h3, h4 { diff --git a/css/style.css b/css/style.css index 160bd55e..dfb2bc65 100644 --- a/css/style.css +++ b/css/style.css @@ -296,3 +296,39 @@ form dt, dl.pairs dt { form dd, dl.pairs dd { background-color:#eeeeee; } + +#set-susper-default{ + width: 250px; + box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19); + position: absolute; + right: 10px; + bottom: 20px; +} + +#set-susper-default h3{ + margin-top: 0; + padding: 8px; + text-align: center; + background-color: #26547c; + color: white; +} + +#set-susper-default ol{ + font-size: 15px; +} + +#set-susper-default button{ + background-color: #26547c; + border: none; + color: white; + font-size: 15px; + padding: 3px; +} + +#set-susper-default #cancel-installation{ + width: 100%; +} + +#set-susper-default #install-susper{ + padding: 5px; +} diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_AWS.md b/docs/INSTALLATION_AWS.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION_AWS.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_DIGITALOCEAN.md b/docs/INSTALLATION_DIGITALOCEAN.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION_DIGITALOCEAN.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_DIGITAL_OCEAN.md b/docs/INSTALLATION_DIGITAL_OCEAN.md new file mode 100644 index 00000000..00526233 --- /dev/null +++ b/docs/INSTALLATION_DIGITAL_OCEAN.md @@ -0,0 +1 @@ +## Deploying diff --git a/docs/INSTALLATION_DOCKER.md b/docs/INSTALLATION_DOCKER.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION_DOCKER.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_GOOGLE.md b/docs/INSTALLATION_GOOGLE.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION_GOOGLE.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_HEROKU.md b/docs/INSTALLATION_HEROKU.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION_HEROKU.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_LOCAL.md b/docs/INSTALLATION_LOCAL.md new file mode 100644 index 00000000..8a03910a --- /dev/null +++ b/docs/INSTALLATION_LOCAL.md @@ -0,0 +1 @@ +# How to install diff --git a/docs/INSTALLATION_VAGRANT.md b/docs/INSTALLATION_VAGRANT.md new file mode 100644 index 00000000..538b8e2b --- /dev/null +++ b/docs/INSTALLATION_VAGRANT.md @@ -0,0 +1 @@ +# How to install diff --git a/images/susper.png b/images/susper.png new file mode 100644 index 00000000..cab70c78 Binary files /dev/null and b/images/susper.png differ diff --git a/images/susper.svg b/images/susper.svg new file mode 100644 index 00000000..d834237e --- /dev/null +++ b/images/susper.svg @@ -0,0 +1,139 @@ + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + diff --git a/index.html b/index.html index 72924fe1..20f4f895 100644 --- a/index.html +++ b/index.html @@ -6,26 +6,26 @@ --> - + - + - - - - - + + + + + - + @@ -34,7 +34,7 @@ - + - - + + + +
+

Set Susper as your default search engine on Mozilla!

+
    +
  1. +
  2. Mark the checkbox to set Susper as your default search engine
  3. +
  4. Start searching!
  5. +
+ +
+ + +
+
+ + - - + - \ No newline at end of file + diff --git a/yacysearch/usage.html b/yacysearch/usage.html index b4482dbd..2e92a380 100644 --- a/yacysearch/usage.html +++ b/yacysearch/usage.html @@ -6,18 +6,18 @@ --> YaCy Search Portal - + - - - - - + + + + + @@ -41,16 +41,16 @@ - - + + @@ -65,15 +65,15 @@ - - + + - Usage of Search Templates + Usage of Search Templates

Run YaCy

-

First, you need a running YaCy Server and you must put in the documents to search.
Download YaCy

+

First, you need a running YaCy Server and you must put in the documents to search.
Download YaCy

Modify the YaCy Server Address

Open the file js/setup.js and put in the server address of your YaCy. If you run YaCy with default settings on the same server with these files, then just leave everything as it is.

@@ -121,4 +121,4 @@

License: (CC-BY 2.0) and GPL2

- \ No newline at end of file +