Core library for developing remixable Koji templates.
The @withkoji/core package enables you to implement core platform features in your Koji template, including remixing, in-app purchases, UI controls, messaging, and identity services.
Install the package in the frontend and backend services of your Koji project.
npm install --save @withkoji/core
Package documentation is available here.
If you are migrating a project from the React/Express Scaffold, you may find these frontend and backend guides helpful.
Enable the user to upload an image from the frontend of the Koji.
import Koji from '@withkoji/core';
const captureImage = async () => {
const imageURL = await Koji.ui.capture.image();
console.log(imageURL); // The publicly accessible, CDN-backed path of the user's uploaded image
}
Use the Koji database on the backend of the Koji, and use middleware to scope operations per remix.
import { KojiBackend } from '@withkoji/core';
import cors from 'cors';
import express from 'express';
import bodyParser from 'body-parser';
const app = express();
// Enable cors for preflight
app.options('*', cors());
// Whitelist all routes with cors
app.use(cors());
// Use express json
app.use(express.json());
// Parse application/json
app.use(bodyParser.json());
// Use Koji's middleware to handle scoping across your template's remixes
app.use(KojiBackend.middleware);
app.get('/data', (req, res, next) => {
const database = new KojiBackend.Database({ res });
// Look up an item in the items collection
const item = await database.get('items', 'myItemId');
res.status(200).json({
item,
});
});
app.listen(PORT, () => {
console.log(`Server is listening on port ${PORT}`);
});
See the contributions page on the developer site for info on how to make contributions to Koji repositories and developer documentation.
For any questions, reach out to the developer community or the @Koji Team on our Discord server.