Skip to content

UXSoc/UX-glitch

 
 

Repository files navigation

Build Status

Glitch Sync Template

Glitch is a super cool platform that lets you edit, collaborate, and publish your Node.js apps. It does have GitHub support but lacks a lot of features.

This is a template to enable a lot of extra functionality, and is great way to learn CD/CI.

Glitch is perfect for bots, small projects, and fun apps. Here's why you should consider using this template:

Pros

  • Free as in pizza 🍕 and source code 📖, by hosting on Glitch.
  • Relatively easy to setup, with full and extendable control over how deployments work.
  • Gets all the benefits of Glitch (collaboration, live code) with a convenient way to reset changes after saving them through GitHub.

Cons

  • Only supports Node.js.
  • Glitch has some resource restrictions in place, although they are hard to hit or can be circumvented.
  • Glitch API is unfortunately not dependable, use at your own risk.

How To Use

For basic usage, run npm i, then npm start to get a web server.

Start with a tutorial to setup with Glitch.

Or click for the video tutorial to setup:

Glitch.com and GitHub Sync Setup Tutorial

If you want know what else you can do check out extras to customize your workflow.

Consider security implications.

Commands After Setup

  • npm run sync will make Glitch redeploy the project to the current main branch of this GitHub repo.
  • npm run safe-sync does the same as sync, but the command being run isn't printed to console, which hides the secret variables. Ideal for Travis CI, or any public place sync is being ran.
  • npm run update with run git push, then sync for you. Simplifies deploying changes from 2 commands to 1.

About

Made by Jonathan Burns, enjoy the 🐟🐟

Feel free to open a Pull request ⬆️.

About

Easy Node.js template for free CD/CI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%