Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/travishorn/typescript-dog

A sample project that runs in the browser. Using TypeScript, Parcel, and Jest.
https://github.com/travishorn/typescript-dog

Last synced: 28 days ago
JSON representation

A sample project that runs in the browser. Using TypeScript, Parcel, and Jest.

Awesome Lists containing this project

README

        

# TypeScript Dog

A sample project that runs in the browser. Using TypeScript, Parcel, and Jest.

## Setup

Clone the repository.

```
git clone https://github.com/travishorn/typescript-dog.git
```

Change into the directory.

```
cd typescript dog
```

Install dependencies

```
npm install
```

## Develop

Run the development server.

```
npm run dev
```

The development server will be listening at http://localhost:1234

Source code is written in the `src/` directory.

## Test

Test are written using the Jest in the `test/` directory.

Run them via npm.

```
npm run test
```

## Deploy

Build for production.

```
npm run build
```

Built files can be found in the `dist/` directory. Push those to any hosting
provider you wish.

## License

The MIT License

Copyright 2019 Travis Horn

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.