corejam.io | [email protected]

Corejam is currently under heavy development and THERE IS NO STABLE RELEASE. We currently do not offer an upgrade path and there will be breaking changes until we hit 1.0.0

If you have ideas for contributing please open an issue before investing time to make sure we can align everyone in the early stages.

About Corejam

Corejam is a serverless first jamstack scaffolding focused on reusability and simplicity. Use it on its own or inside your favourite tool of choice.

Core

At its base, Corejam will provide the following tools:

• A GraphQL endpoint which you can feed your schema(s) to quickly start querying / resolving against
• Plugin Mapper to easily allow third party developers to build new functionality or fully fledged serverless systems with ease
• Caching layer
• Server side render & Static site generation
• Bootstrapped web components to allow you to query your GraphQL endpoint and start building right away
• An event system to allow you to hook into and listen to events across the system
• A visual canvas to allow you to drag and drop web components from the web into the page you are building

Usage

npm

$ npm i -g @corejam/cli

yarn

$ yarn global add @corejam/cli

Creating your first Corejam Application

$ corejam createApp <applicationName>

$ cd <applicationName>
$ yarn dev

You can now access the developer playground on http://localhost:3001 and the API on http://localhost:3000

Static build of your Application

To create a static build of your application run the following:

$ cd <applicationName>
$ corejam static

Plugins maintained in this mono repo:

We keep a collection of plugins maintained inside this monorepo:

Auth

Basic GraphQL JWT authentication for Corejam applications. Read more

A hassle free plug and play JWT authentication package for your Corejam applications to give you an authentication state to use inside your applications.

DerShop - demo.dershop.dev

Serverless webshop built with Corejam. Read more

We currently only build React output targets but we plan on supporting all Stencil.js supported targets. Feel free to contact us if you want to help out.

Mono repo development setup

We use lerna / yarn to manage our packages.

$ yarn --frozen-lockfile
$ yarn build
$ yarn bs

Debugging configuration

If you are using VSCode you can use the commited vscode configuration to jump right in. Simply choose the configuration you want and hit run.

For hooking / debugging into the running corejam server boot the api in whichever package you like using yarn corejam api:serve and you can then run the @corejam:api configuration to select your running process.