Skip to content

Commit

Permalink
refactor: organize files and code
Browse files Browse the repository at this point in the history
  • Loading branch information
abbotto committed Sep 14, 2019
1 parent 3cf53d0 commit 8418b14
Show file tree
Hide file tree
Showing 71 changed files with 1,040 additions and 5,105 deletions.
1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
dist/**/*
node_modules/**/*
142 changes: 0 additions & 142 deletions .eslintrc

This file was deleted.

1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('./dev/cfg/eslint.es6.js');
56 changes: 9 additions & 47 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,61 +1,23 @@
# Blacklist Everything
# Ignore Everything
*

# Whitelist items
!.nvmrc
!.eslintignore
!.eslintrc.js
!.gitignore
!.nvmrc
!.travis.yml
!gulpfile.js
!bower.json
!package.json
!jsdoc.json
!license.md
!CONTRIBUTING.md
!LICENSE.md
!README.md
!.eslintrc
!.eslintignore
!package.json
!teleprint.js
!teleprint.min.js

!/dev
!/dev/**/*

!/src
!/src/**/*

!/dist
!/dist/**/*

!/test
!/test/**/*

# Documentation exceptions
!/docs
!/doc/**/*
/docs/styles/*.*
!/docs
!/docs/styles
!/docs/styles/sunlight.dark.css
!/docs/styles/site.teleprint.css

# Blacklist items
.DS_Store
/test/test.js
darkstrap.css
sunlight.default.css
prettify-tomorrow.css
site.darkly.css
site.lumen.css
site.slate.css
site.yeti.css
site.darkstrap.css
site.paper.css
site.spacelab.css
site.cerulean.css
site.dibs-bootstrap.css
site.readable.css
site.superhero.css
site.cosmo.css
site.flatly.css
site.sandstone.css
site.cyborg.css
site.journal.css
site.simplex.css
site.united.css
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8
10
27 changes: 25 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
language: node_js

notifications:
email: false

sudo: required

node_js:
- "6.10"
- "8.9"

env:
- CXX=g++-4.8

addons:
apt:
sources:
- google-chrome
packages:
- chromium-browser

cache:
directories:
- node_modules

branches:
only:
- master

before_install:
- export CHROME_BIN=chromium-browser

script:
- npm i
- npm start
- npm test
- npm test
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Contributing

## Licensing

All code contributions will be accepted under the [MIT Software License](https://raw.githubusercontent.com/abbotto/elemint/master/LICENSE.md)

## Bug Reports

A good bug report should contain some or all of the following information:
Expand Down Expand Up @@ -32,14 +36,14 @@ A good bug report should contain some or all of the following information:
### Use semantic commit messages

- `build`: Changes to the build system and external dependencies.
- `ci`: Changes to the CI files.
- `deploy`: Changes to the deployment files.
- `doc`: Changes to the documentation.
- `feat`: Add new behaviour to the code.
- `feat`: Introduce new behaviour in the code.
- `fix`: Fix malfunctioning code.
- `perf`: Changes that improve code performance.
- `refactor`: Restructure code without changing the behaviour.
- `refactor`: Change code without altering the external behaviour.
- `style`: Changes based on project conventions and linting rules.
- `test`: Add or edit tests.
- `test`: Changes to the testing files and environemnt.

```
feat: do all the things
Expand All @@ -58,3 +62,5 @@ feat: do all the things
- Linux
- Mac OS
- Windows (via [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10))

##### Thank you for reading this document - please feel free to contribute
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,28 @@
# Teleprint
[![GitHub version](https://badge.fury.io/gh/abbotto%2Fteleprint.svg)](https://badge.fury.io/gh/abbotto%2Fteleprint)
[![NPM version](https://badge.fury.io/js/teleprint.svg)](http://badge.fury.io/js/teleprint)
[![Build Status](https://travis-ci.org/abbotto/teleprint.svg?branch=master)](https://travis-ci.org/abbotto/teleprint)
[![David](https://img.shields.io/david/expressjs/express.svg)](https://david-dm.org/abbotto/teleprint.svg)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE.md)
<a href="https://twitter.com/intent/tweet" target="_blank"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"/></a>

### What does it do?
- It can print HTML from a URL, from the DOM, or from a string.
- It can apply the current document's styles and scripts to the printed HTML.
- It can apply custom styles and scripts to the printed HTML.

## Package Information
[![NPM version](https://badge.fury.io/js/teleprint.svg)](http://badge.fury.io/js/teleprint)
[![GitHub version](https://badge.fury.io/gh/abbotto%2Fteleprint.svg)](https://badge.fury.io/gh/abbotto%2Fteleprint)
[![Bower version](https://badge.fury.io/bo/teleprint.svg)](http://badge.fury.io/bo/teleprint)
## Overview
- Print HTML from a URL, from the DOM, or from a string.
- Apply the current document's styles and scripts to the printed HTML.
- Apply custom styles and scripts to the printed HTML.

## Build Requirements

### Install NPM packages
Install NPM packages

nvm use && npm i

### Build the distribution
Build the distribution

npm start

## Documentation
- [https://abbotto.github.io/teleprint/teleprint.html](https://abbotto.github.io/teleprint/teleprint.html)
- [https://abbotto.github.io/teleprint/index.html](https://abbotto.github.io/teleprint/index.html)

## Demonstration
- [http://codepen.io/abbotto/pen/JRGzyo](http://codepen.io/abbotto/pen/JRGzyo)

## License
[![MIT](https://badges.frapsoft.com/os/mit/mit.svg?v=102)](https://github.com/abbotto/teleprint)
[![Semver](http://img.shields.io/SemVer/2.0.0.png)](http://semver.org/spec/v2.0.0.html)
23 changes: 0 additions & 23 deletions bower.json

This file was deleted.

Loading

0 comments on commit 8418b14

Please sign in to comment.