npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jade-framework/jade

v2.0.8

Published

An open source deployment environment for JAMstack applications

Downloads

14

Readme

Jade logo

Jade is a framework to help users automate the deployment of JAMstack applications with AWS and GitHub. For more details on Jade or the JAMstack, please visit our website.

Setup guide

To install the Jade package, run

$ npm install -g @jade-framework/jade

In order to use Jade, you will need an AWS account, a Gatsby project and a public GitHub repo. To get started, you may use our Gatsby template here or follow the official Gatsby instructions to set up a Gatsby project here.

To provision your AWS services, run

$ jade init

You will be prompted for the following information:

  • Your project name
  • Your GitHub repo
  • Other relevant configuration commands (use the Jade defaults if you're running a Gatsby template)

Jade commands

| Command | Description | | -------------------------- | ------------------------------------------------------------ | | jade init | Initialize a new JAMstack app and associated AWS services | | jade add | Add a new JAMstack app | | jade list | List all your existing JAMstack apps | | jade freeze <app name> | Freeze your EC2 instance when you aren't developing your app | | jade unfreeze <app name> | Unfreeze your EC2 instance to continue development | | jade delete <app name> | Remove an app and its associated AWS infrastructure | | jade destroy | Remove all apps and all Jade AWS infrastructure |

Notes regarding Jade commands

jade init and jade add will provision a new EC2 instance for each app. In order for the EC2 instance to pull source code on updates, a webhook must be setup on GitHub with it's destination address set to the EC2 instance's public IPv4 adress. The IP address and instructions on how to setup a GitHub webhook will be provided by Jade when a new app is deployed.

jade freeze will stop the EC2 instance. When this happens the EC2 instance will lose its public IPv4 address. The project's GitHub webhook destination address will need to be updated when the EC2 instance is restarted.

jade unfreeze will restart the EC2 instance and a new IPv4 address will be assigned. Please note that you have to change the GitHub webhook IP address when you unfreeze the app. You can use jade list or jade admin to see the new IP address of the EC2 instance associated with the app.

jade destroy will give the option to synchronously or asynchronously remove all apps and their associated AWS infrastracture. Due to the nature of CloudFront, it can take up to 90 minutes to remove a distribution.

Concluding remarks

Thanks for checking out the Jade framework! Please feel free to reach out to us with any questions and to discuss our code.

Team Jade

License

This NPM package is available as open source under the terms of the MIT License.