mike-engel / preact-cli-typescript-sample

An example of how to use typescript with preact-cli and all its goodies

preact-cli-typescript-example

An example of how to use typescript with preact-cli and all its goodies

Why?

Preact and preact-cli are awesome! Typescript is awesome! Trying to use them together out of the box, however, is not so awesome. There are some cool projects like preact-cli-plugin-typescript help a little, but I still found myself fighting to get it to build and include ideas like code splitting. So that's why I made this repo while working on a side project.

Installing

Begin by cloning or forking this repo with git or github. Once you have it on your machine, run the following commands.

# install dependencies
npm install

# start the web app and development server
npm start

At this point, you should be able to open your browser and go to localhost:8080. You'll notice that the app compiles and also includes code splitting!

Deploying

While this app doesn't do much on it's own, if you want to deploy it somewhere to see the lighthouse score or offline capabilities, run the build command and serve/upload those files somewhere. I recommend now.sh.

# build the app into a static set of files
npm run build

# deploy somewhere. This example uses now.sh
now ./build

Contributing

I'd love to get your feedback and suggestions via issues and pull requests on this repo! All I ask is that you follow the code of conduct.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

preact-cli-typescript-sample's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.