Merge pull request #46 from zschaffer/readme

update: adjusted readme
This commit is contained in:
Xinrui Chen 2022-07-22 15:04:27 -07:00 committed by GitHub
commit 315a8ef5cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 23 additions and 20104 deletions

View File

@ -3,5 +3,27 @@
## About
This project is a collaborative effort to catalogue and rate everything in existence.
Written in `Svelte` with `TailwindCSS` and `Sanity`.
Written in `Svelte` with `TailwindCSS`, `Typescript`, and `Sanity`. Testing is implemented in `Jest` and `Playwright`.
## Usage
```js
npm run dev
```
Runs client in `vite`.
```bash
yarn test:unit
yarn test
```
Testing: Unit tests run in `Jest`, integration tests run in `Playwright`.
## Functionality
Home Page and Product View
![home](static/home.gif)
Live Product Searching
![search](static/searchRecord.gif)
Filtering/Sorting
![filter/sort](static/filterSortRecord.gif)

20103
package-lock.json generated

File diff suppressed because it is too large Load Diff

BIN
static/filterSortRecord.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 537 KiB

BIN
static/home.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

BIN
static/searchRecord.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 369 KiB