https://github.com/magentanova/tiy-starter-kit

simple build system for javascript apps
https://github.com/magentanova/tiy-starter-kit

babel browserify javascript post-css scss

Last synced: about 2 months ago
JSON representation

simple build system for javascript apps

• Host: GitHub
• URL: https://github.com/magentanova/tiy-starter-kit
• Owner: magentanova
• License: mit
• Created: 2016-07-07T18:20:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-14T21:42:01.000Z (about 8 years ago)
• Last Synced: 2024-11-14T05:27:06.072Z (about 2 months ago)
• Topics: babel, browserify, javascript, post-css, scss
• Language: JavaScript
• Homepage:
• Size: 1.49 MB
• Stars: 1
• Watchers: 1
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
#TIY Starter Kit

Lightweight scaffolding and build tools to quickly and easily develop a web application. 

  - transpiles scss into css

  - transpiles es6 and jsx into es5

  - concatenates all required/imported modules together into one minified file

  - runs a simple express server that is deployable on heroku

  

##Getting started

  - clone this repo with `git clone [email protected]:magentanova/tiy-starter-kit.git THE-LOCAL-FOLDER-YOU-WANT-TO-CREATE`

  - `cd` into the local folder

  - disconnect from my remote repo and point to your own (see [Publishing](#publishing))

  - `npm install`

  - `npm run go`

  - that's it! visit [http://localhost:3000](http://localhost:3000) to make sure it's working

  

##Workflow

  

  - you'll *only* write code in the files in the `src/` folder

  - every time you save in that folder, your code will be read and transpiled into the `dist/` folder. only files in `dist/` will be served up to the browser.

  - view and test your app at [http://localhost:3000](http://localhost:3000)

  

##Publishing

  - disconnect your local repo from this one with `git remote remove origin`

  - `hub create YOUR-APP-NAME` -- this will simultaneously (1) create you a remote repo with the given name and (2) create a local reference connecting the directory you're in to the remote you just created

  - add, commit and push per usual

##Deploying 

The easiest thing to do is deploy to heroku. Once you have an account and you've installed the heroku command line tools, simply run: 

 

  - `heroku create YOUR-APP-NAME`

  - `git push heroku master`

Have fun!