Setup

Setting up your Framework instance is fairly straightforward. This guide will walk you through the process of setting up your instance!

Prerequisites

• Node.js (recommended version: 16.x) - Node.js is a JavaScript runtime that allows you to run JavaScript code outside of a web browser. Framework uses Node.js to run the server-side code.
• Yarn package manager - Yarn is a package manager for Node.js that allows you to install and manage dependencies for your Framework instance.
• PostgreSQL database - PostgreSQL is a relational database management system that Framework uses to store data. You'll need to set up a PostgreSQL database and obtain the connection details before you can set up your Framework instance.

Clone the repository

Clone the Framework repository from our GitLab instance:

git clone https://invent.solarius.me/Soodam.re/framework.git

Install dependencies

Navigate into the cloned directory and install the dependencies by running the following command:

cd framework/
yarn

Configure environment variables

The Framework platform uses environment variables for configuration. Rename the .env.example file to .env and edit it to suit your needs. The most important environment variable to configure is the DATABASE_URL, which should contain the connection details for your PostgreSQL database.

DATABASE_URL=postgresql://user:password@localhost:5432/database

Set up the database

• Run the following command to set up a PostgreSQL database and apply the migrations:

  yarn run migrate
  

• Run the following command to seed the database with initial data:

  yarn run seed
  

Set up an admin account

Run the following command to set an admin password:

yarn run ctl --set-pwd your_admin_password

Set up sub-projects

Run this command to install dependencies and initialize sub-projects.

yarn run setup-projects

Build and start Framework

• Build the platform by running the following command:

  yarn run build
  

• Start Framework by running the following command:

  yarn run start
  

Access your new Framework instance

Open your web browser and navigate to http://localhost:3000 to access Framework! Use the admin username and password you set up earlier to log in.