andreros/typescript-boilerplate

Boilerplate for a Typescript project with SASS for CSS and Handlebars for HTML templating.

Typescript Boilerplate

Boilerplate for a Typescript project with SASS for CSS and Handlebars for HTML templating.

Motivation

In a fast evolving tech world, it is vital to keep up the pace. The creation of this boilerplate project comes both from the necessity of learning how to properly assemble, configure and troubleshoot a TypeScript project from scratch, including all the needed dependencies and specificities, as well as, have a ready-to-go solution for new projects to come.

This project also intends to be a comprehensive guide to anyone wanting to follow the same path and assemble his own project from scratch. If you are planning to do so, please take a look at the project documentation.

Prerequisites

Node.js

Node installation

Please, read the Node.js official installation guide.

Gulp

Gulp uses Node for core processing, npm to manage project dependencies, and gulp.js to run tasks and interface with the core library. Node version 8 or higher suffices. You can follow the directions for installing Node on the Node website if you haven't done so already. Installation of Node will include npm. In order to run this project gulp tasks it is highly recommended that you install gulp globally.

Gulp installation

From the command line (Windows, Mac or Linux), please execute the following command:

npm install --global gulp-cli

Installation

Clone or download this project. From the project directory run the command npm install.

Local Development

To run the project in development mode, from the project directory run the command npm run dev. Your default browser should open a window with the project running from http://localhost:3000/.

Built With

• SASS CSS Pre-processor: https://sass-lang.com/
• Handlebars Templating Engine: http://handlebarsjs.com/
• TypeScript Scripting Language: https://www.typescriptlang.org/
• Browserify modules / dependencies bundler: http://browserify.org/
• Gulp Task Automator: https://gulpjs.com/
• Browser Sync Server Synchronizing Tool: https://browsersync.io/

Contributing

1. Fork this project: https://github.com/andreros/typescript-boilerplate/fork
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

Author

André Rosa

• https://bitbucket.org/candrelsrosa
• https://github.com/andreros/
• https://facebook.com/candrelsrosa
• https://twitter.com/candrelsrosa

License

This is free and unencumbered software released into the public domain. For more information, please refer to http://unlicense.org.