Skip to content

Commit

Permalink
chore(SFINT-3304): Fix typos and formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
lbergeron committed Jul 6, 2020
1 parent 09fce17 commit 813163b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@
[![Coverage Status](https://coveralls.io/repos/github/coveo/search-ui-extensions/badge.svg?branch=master)](https://coveralls.io/github/coveo/search-ui-extensions?branch=master)
[![Known Vulnerabilities](https://snyk.io/test/github/coveo/search-ui-extensions/badge.svg?targetFile=package.json)](https://snyk.io/test/github/coveo/search-ui-extensions?targetFile=package.json)

This repository contains additionnal components meant to be used in conjunction with [Coveo Javascript Search Framework](https://github.com/coveo/search-ui) to provide additionnal functionnalities.
This repository contains additional components meant to be used in conjunction with [Coveo Javascript Search Framework](https://github.com/coveo/search-ui) to provide additional functionalities.

## Setup

Requires Node JS >= 8.0.

1. `npm install`

2. `npm run build`

## Structure
Expand All @@ -21,6 +22,7 @@ The code is written in [typescript](http://www.typescriptlang.org/) and compiled
- Under the `pages` folder, you have a working search page (index.html). 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 for the custom components, with `src/Index.ts` being the starting point of the application.
Expand All @@ -32,7 +34,9 @@ The code is written in [typescript](http://www.typescriptlang.org/) and compiled
## Build tasks

- `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
Expand All @@ -44,11 +48,13 @@ Then, anytime you hit save in a typescript file, the server will reload your app
## Tests

- `npm run test` will execute the tests one time and give you the report
- `npm run watchTest` will watch changes and reexecute the tests and coverage when saving a file.

- `npm run watchTest` will watch changes and re-execute the tests and coverage when saving a file.

## Running functional tests

1. `npm run dev` will start the developer server.

2. `npx cypress run` will run the cypress functional tests suite.

To add a new test suite simply add a new spec file in the `./cypress/integration/` folder.

0 comments on commit 813163b

Please sign in to comment.