letsjam

letsjam

Ship products faster by adding jam to any project!

Get started by visiting jam.dev.

Install

npm install --save letsjam

Usage

import React from "react"

import Jam from "letsjam"

const App = () => {
  return <Jam JAM_ID="YOUR_JAM_ID" />
}

Development

First you will run npm install && npm start in the root directory...

cd letsjam
rm -rf node_modules/
npm install
npm start

Then in a new tab in the terminal, you will cd into the example folder which contains a janky little test website (all of the images and things in the site are broken -- it's not you, it's us) and npm intall && npm start there. That will let you preview the npm library on the example site.

cd example
rm -rf node_modules
npm install
npm start

Once you are running the example site, you will want to light up jam and try jamming. To do that, type jam into the example site (it's like a secret password to light up jam, there's no form field, you just type it blankly into the site) you'll enter in your email address and off you go!

It's also great to try the dev local version of the letsjam library on other react apps you happen to have installed and running on your computer. How you do that is:

• First run pwd inside the 'letsjam' directory to find the absolute path for the letsjam directory. Copy the absolute path for letsjam.

• Make sure letsjam is running by using npm start inside the letsjam directory. This will make sure that any changes you make inside letsjam gets compiled automatically to dist.

• Go to your other react or nextjs project directory and do npm install absolute/path/for/letsjam/directory (or yarn add)

• To verify that your project correctly installed the latest letsjam module your package.json letsjam line will look like: "letsjam": "file:../letsjam"

• If you see any errors at all, just rm- rf node_modules, rm package-lock.json and try again :)

License

GNU AGPLv3 © Strawberry-Jam-Manufacturers