Skip to content

Commit 6eba025

Browse files
jbucknerjbuckner
authored
Add Internet Archive Customizations (#1)
Add the base set of IA-customizations. Changes: - Add .travis.yml file - Change LICENSE to AGPL - Add badges to Readme - Set base font size - Add circular dependency checking - Export types - Add sinon for test-helpers - Update typescript - Update some eslint settings
1 parent 4da7d07 commit 6eba025

File tree

11 files changed

+5662
-15512
lines changed

11 files changed

+5662
-15512
lines changed

‎.travis.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
language: node_js
2+
node_js:
3+
- node
4+
5+
notifications:
6+
slack:
7+
rooms:
8+
- secure: FILL_IN_SECURE_TOKEN
9+
if: fork = false
10+
11+
cache: yarn
12+
13+
install:
14+
- yarn global add codecov
15+
- yarn install
16+
17+
script:
18+
- yarn test
19+
20+
after_success:
21+
- codecov

‎LICENSE‎

Lines changed: 661 additions & 21 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1+
***UPDATE BADGE URLS BELOW***
2+
3+
[![Build Status](https://travis-ci.com/internetarchive/iaux-donation-form.svg?branch=master)](https://travis-ci.com/internetarchive/iaux-donation-form)
4+
5+
[![codecov](https://codecov.io/gh/internetarchive/iaux-donation-form/branch/master/graph/badge.svg)](https://codecov.io/gh/internetarchive/iaux-donation-form)
6+
17
# \<typescript-template>
28

39
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
410

511
## Installation
612
```bash
7-
npm i typescript-template
13+
yarn add typescript-template
814
```
915

1016
## Usage
@@ -19,40 +25,40 @@ npm i typescript-template
1925
## Linting with ESLint, Prettier, and Types
2026
To scan the project for linting errors, run
2127
```bash
22-
npm run lint
28+
yarn run lint
2329
```
2430

2531
You can lint with ESLint and Prettier individually as well
2632
```bash
27-
npm run lint:eslint
33+
yarn run lint:eslint
2834
```
2935
```bash
30-
npm run lint:prettier
36+
yarn run lint:prettier
3137
```
3238

3339
To automatically fix many linting errors, run
3440
```bash
35-
npm run format
41+
yarn run format
3642
```
3743

3844
You can format using ESLint and Prettier individually as well
3945
```bash
40-
npm run format:eslint
46+
yarn run format:eslint
4147
```
4248
```bash
43-
npm run format:prettier
49+
yarn run format:prettier
4450
```
4551

4652
## Testing with Web Test Runner
4753
To run the suite of Web Test Runner tests, run
4854
```bash
49-
npm run test
55+
yarn run test
5056
```
5157

5258
To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run
5359

5460
```bash
55-
npm run test:watch
61+
yarn run test:watch
5662
```
5763

5864

@@ -64,6 +70,6 @@ If you customize the configuration a lot, you can consider moving them to indivi
6470

6571
## Local Demo with `web-dev-server`
6672
```bash
67-
npm start
73+
yarn start
6874
```
6975
To run a local development server that serves the basic demo located in `demo/index.html`

‎demo/index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
<head>
44
<meta charset="utf-8">
55
<style>
6+
html {
7+
font-size: 10px; /* This is to match petabox's base font size */
8+
}
9+
610
body {
711
background: #fafafa;
812
}

‎index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export { TypescriptTemplate } from './src/TypescriptTemplate.js';
1+
export { TypescriptTemplate } from './src/typescript-template';

0 commit comments

Comments
 (0)