README
¶
cosr-front
This repository contains the frontend for Common Search. A demo is currently hosted on uidemo.commonsearch.org
Help is welcome! We have a complete guide on how to contribute.
Understand the project
The frontend has 2 main components:
- A Go server that receives user queries (as HTTP GETs for page loads or AJAX calls), sends them to an Elasticsearch index, and then returns results as HTML or JSON.
- An optional JavaScript/CSS layer that provides a fast, single-page search experience to the otherwise static result pages.
Here is how they fit in our general architecture:
Local install
A complete guide available in INSTALL.md.
Launching the tests
You can run our full server test suite easily:
make docker_test
You can also launch our automated UI tests:
make start_services_devindex
make docker_uitest
On your local machine they will use PhantomJS by default but we run them with Sauce Labs on many different browsers at each push. See the latest builds on Sauce Labs.
Check out the Makefile for additional test, lint & build commands!
How to contribute
Everything you need to know is in CONTRIBUTING.md. We also have a tutorial on how to send your first Frontend patch.
Thanks for joining the adventure!
Directories