/hackathon12-2016

Primary LanguageJavaScript

search-ui-seed

A fast starter / seed project to extend the Coveo Javascript Framework

This project is meant to display a working starting point for a project that wish to extend the Coveo Javascript Search Framework with additional components.

Setup

  1. Fork / clone the repository.
  2. npm install at the top of the repository.
  3. npm run build at the top of the repository.
  4. Open ./bin/Index.html in a browser. You should get a working search page with a big Hello World message at the top of the search page.

Structure

The code is written in typescript and compiled using webpack

  • Under the pages folder, you have a working search page. At build time, it is copied to the bin folder.

    • It references 2 style sheets (the base one from the Coveo Javascript Search Framework, and the one from the extension).
    • It references 3 javascript file (the extension one built in this project, and the basic templates and library scripts).

  • Under the src folder, you have all the typescript source code.

    • The src/ui/HelloWorld.ts file is a sample/demo component
    • The src/Index.ts file is the starting point of the application.

  • Under the sass folder, you have all the css for the extension.

Build task

  • npm run setup will copy the needed ressources (index.html, templates, etc.) in the bin folder.
  • npm run css will build the sass files into a css file in the bin folder.
  • npm run build will run the setup, css task, then compile the typescript code.

Dev

npm run dev will start a webpack dev server. After it finishes, load http://localhost:8080/index.html in a browser, and the index.html page should load.

Then, anytime you hit save in a typescript file, the server will reload your application.

Todo

Setup unit tests.