Freym demo app

This demo app is intended to be a starting point to try out Freym. Please have a look at the Freym documentation, too.

Get in touch

The Freym demo is a closed demo. To get a running demo instance of Freym please get in touch with us

Local setup

• Get in touch with us and request a demo instance. We will provide all needed configuration values:
  • customerId: An id that identifies your demo instance
  • jwtSecret: The secret used to sign jwts that work with your instance
  • migrationsAddress: The address of the migrations api
  • migrationsApiToken: A token used to authenticate against the migration api
• Clone this repo
• Replace all occurances of demo in tsconfig.json with your customerId
• Copy the .env.template and name the new file .env.local
• Use the customerId as the value for NEXT_PUBLIC_CLIENT_NAME
• Use the jwtSecret as the value for JWT_SECRET
• Copy the ./schema/.env.template and name the new file ./schema/.env
• Use the migrationsAddress as the value for MIGRATIONS_SERVER_ADDRESS
• Use the migrationsApiToken as the value for MIGRATIONS_API_TOKEN
• Run make migrate to apply the schema within ./schema to Freym
• Don't forget to install the dependencies: npm install

Start the demo app

Run npm run dev to start the frontend app locally. Open localhost:3000 in your browser.

Login

Besides the configuration values you will get user credentials that you can use to sign in to the application.

Sandboxes + JWT

In order to use the graphql sandboxes you need to provide a jwt. You can retrieve the jwt from the local-storage value named jwt, which is saved when you log in.

Add the jwt as a bearer token to the Authorization header when configuring the sandbox.

Execute Freym migrations

Run make migrate to apply the the schema within ./schema to Freym. To learn more about Freym schema and migrations please have a look at our docs:

• Projection schema definition
• Crud schema definition
• Auth schema definition
• Executing migrations