# @polyratings/shared

> Polyratings shared types

Latest version **0.0.2** (published 2022-03-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install @polyratings/shared
pnpm add @polyratings/shared
yarn add @polyratings/shared
bun add @polyratings/shared
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-03-26 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 380.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 18 |
| Maintainers | mfish33 |

## Links

- npm: https://www.npmjs.com/package/@polyratings/shared
- Repository: https://github.com/mfish33/polratings-revamp
- Homepage: https://github.com/mfish33/polratings-revamp#readme
- Issues: https://github.com/mfish33/polratings-revamp/issues
- npm.io page: https://npm.io/package/@polyratings/shared

## Dependencies (2)

- [class-validator](https://npm.io/package/class-validator.md) ^0.13.2
- [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1

## Recent versions

- 0.0.2 (latest) — 2022-03-26
- 0.0.1 — 2022-03-17

## README

# Polyratings Monorepo

Lerna monorepo to contain all polyratings related code

## Packages

- [frontend](./packages/frontend/) - Frontend react app deployed at <https://polyratings.dev>
- [backend](./packages/backend/) - Backend typescript app deployed on Cloudflare Workers
- [cron](./packages/cron/) - nightly job that syncs data between environments as well as backs up the professor list to a separate git [repo](TODO://PROVIDE_URL)
- [eslint-config](./packages/eslint-config/) - shared eslint config that is enforced in all other packages

## Setup

Install top level JS dependencies

```bash
npm install
```

This will install lerna and all of the dependencies for all of the sub packages and sym link dependent packages. 


Then run:

```bash
npm run build
```

Finally:
```bash
npm run start:local
```
> Note you can run `npm run start:dev` if you have access to the cloudflare account to use data stored in the dev KV 

This will start the local hot reload server for the frontend and backend. Follow the individual package READMEs for specific package information.

---
_Source: https://npm.io/package/@polyratings/shared · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._