A scaffolding utility to help you instantly set up a functional conjoon app.
npx create-conjoon@latest [name] [targetDir]
npm init @conjoon/conjoon@latest
and follow the instructions on screen.
This command should be preferably used in an interactive shell so all features are available.
The following guides you through the options available during the installation.
name will be used as the
name field in the created app's
package.json and the
title field in the related configurations.
name will also be used as the default site's path, if
targetDir was initially omitted. The site path is computed relative to the current working directory.
Make sure to adjust the meta fields found in the
package.json (repository, author and such) if you plan to fork conjoon and create your own project from it.
targetDir will be used as the target directory for this conjoon installation.
The directory must not yet exist, otherwise the installer will show an error and request a new target directory. If omitted, defaults to
./<name>, but still requires confirmation of the user.
quick: Will install conjoon using its latest release and with demo data from the development release. The production build will be configured with fake endpoints, returning mock data in its responses.
customWill install conjoon and configure it based on the following settings:
Base url for auth
Base url where authentication endpoints are found.
Base url for email
Base url where the rest-api-email-endpoints can be found
Provides a list of the last 5 releases, and a text input to manually enter the required version, if the user wants to install an older release of conjoon. Requested versions will be looked up in the NPM registry. A message will be shown if the release was not found in the registry
Use the quick installation to get the conjoon frontend running locally. You can always configure the application to a later point for connecting to existing backends