Skip to content

Commit

Permalink
Add serverless template (#70)
Browse files Browse the repository at this point in the history
Adds support for the serverless template with some minor updates to dev-toolkit itself and the used templates.

Fixes a vulnerability with yargs.
  • Loading branch information
stoikerty authored Sep 14, 2018
1 parent f2897f7 commit eabe2ea
Show file tree
Hide file tree
Showing 17 changed files with 1,118 additions and 2,165 deletions.
9 changes: 1 addition & 8 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ $ dev-toolkit init [project_name] [--template template_name] [--skip-comments]
- [`standard`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#standard)* [![Vulnerabilities for standard template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fstandard%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fstandard%2Fpackage.json)
- [`with-eslint`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#with-eslint) [![Vulnerabilities for with-eslint template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fwith-eslint%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fwith-eslint%2Fpackage.json)
- [`with-sass`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#with-sass) [![Vulnerabilities for with-sass template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fwith-sass%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fwith-sass%2Fpackage.json)
- [`serverless`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#serverless) [![Vulnerabilities for serverless template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fserverless%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fserverless%2Fpackage.json)

<small>* used by default when initialising a new project</small>

Expand Down Expand Up @@ -67,13 +68,5 @@ The aim of dev-toolkit is to be unopinionated so that it can be useful in many d

With CSS-in-JS solutions on the rise, it would be unwise to include dependencies for `css-modules`, `sass` or `less` in every project that has `dev-toolkit` as a dependency, it would introduce additional installation time and bloat.

### Roadmap

* More docs on extending with config, how dev-toolkit works, choices
* serverless template
* Using your own (external) template - under consideration
* Eject feature - under consideration
* list differences between dev-toolkit, next.js & create-react-app

## Contributing
See [`Contributing.md`](https://github.com/stoikerty/dev-toolkit/blob/master/Contributing.md)
3 changes: 3 additions & 0 deletions docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,9 @@ This template contains no routing or css, it will give you out of the box:
### with-sass
Example using sass/scss with custom webpack configuration and node-hooks.

### serverless
Example using a `handler.js`-file that simulates a serverless scenario. You can test the file with `npm run render`. This file uses the dev-toolkit `preRender` command in programmatic mode which allows to avoid using express for the preRender while still being able to use express for local development with hot-reload using `npm run dev`.

### with-eslint
Example using eslint-configuration.

Expand Down
9 changes: 1 addition & 8 deletions src/packages/dev-toolkit/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ $ dev-toolkit init [project_name] [--template template_name] [--skip-comments]
- [`standard`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#standard)* [![Vulnerabilities for standard template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fstandard%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fstandard%2Fpackage.json)
- [`with-eslint`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#with-eslint) [![Vulnerabilities for with-eslint template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fwith-eslint%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fwith-eslint%2Fpackage.json)
- [`with-sass`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#with-sass) [![Vulnerabilities for with-sass template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fwith-sass%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fwith-sass%2Fpackage.json)
- [`serverless`](https://github.com/stoikerty/dev-toolkit/blob/master/docs/templates.md#serverless) [![Vulnerabilities for serverless template](https://snyk.io/test/github/stoikerty/dev-toolkit/badge.svg?targetFile=src%2Ftemplates%2Fserverless%2Fpackage.json)](https://snyk.io/test/github/stoikerty/dev-toolkit?targetFile=src%2Ftemplates%2Fserverless%2Fpackage.json)

<small>* used by default when initialising a new project</small>

Expand Down Expand Up @@ -67,13 +68,5 @@ The aim of dev-toolkit is to be unopinionated so that it can be useful in many d

With CSS-in-JS solutions on the rise, it would be unwise to include dependencies for `css-modules`, `sass` or `less` in every project that has `dev-toolkit` as a dependency, it would introduce additional installation time and bloat.

### Roadmap

* More docs on extending with config, how dev-toolkit works, choices
* serverless template
* Using your own (external) template - under consideration
* Eject feature - under consideration
* list differences between dev-toolkit, next.js & create-react-app

## Contributing
See [`Contributing.md`](https://github.com/stoikerty/dev-toolkit/blob/master/Contributing.md)
Loading

0 comments on commit eabe2ea

Please sign in to comment.