bdfe3270e2
* docs: jira * docs: formatting + Client Credentials grant type * docs: connection string pgsql * docs: parameterized queries mysql * docs: parameterized queries in PostgreSQL * docs: update mysql example * docs: TJDB sql editor * docs: add metadata to REST API * docs: add, update postgresql media * docs: add metadata to graphql * docs: update parameterized queries * docs: add parameterized queries for mssql * docs: add SSL Cert to mysql * docs: TJDB SQL restricted commands * docs: update JIRA token location * docs: update delete issue example * docs: update find user by query example * docs: remove session id from get assignable users * docs: use correct image for get issues for board * docs: update create issue example * docs: update delete issue media * docs: update assignable users media * docs: update examples * docs: update key desc * docs: v2.68.0-Beta
2.6 KiB
| id | title |
|---|---|
| codespaces | GitHub Codespaces |
Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on architecture of ToolJet before proceeding.
Open the terminal and run the commands below.
Setting up
1. Set up the environment
- Install Node.js ( version: v18.18.2 ) and npm (version: v9.8.1)
nvm install 18.18.2
nvm use 18.18.2
npm install -g npm@9.8.1
- Install Postgres
sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
sudo apt-get update
sudo apt-get install postgresql-13 postgresql-contrib-13
To start the postgresql service run the below command:
sudo service postgresql start
If you wish to change the password of the installed postresql service run the below commands:
sudo su
sudo -u postgres psql
\password postgres
\q
2. Set up environment variables
Create a .env file by running the command touch .env. More information on the variables that can be set is given in the environment variables reference
For basic set-up you add the below env variables:
TOOLJET_HOST=http://localhost:3000
LOCKBOX_MASTER_KEY=
SECRET_KEY_BASE=
PG_USER=postgres
PG_HOST=localhost
PG_PASS=postgres
PG_DB=tooljet_prod
SUB_PATH=/apps/tooljet/
NODE_ENV=production
SERVE_CLIENT=true
SECRET_KEY_BASErequires a 64 byte key. (If you haveopensslinstalled, runopenssl rand -hex 64to create a 64 byte secure random key)
LOCKBOX_MASTER_KEYrequires a 32 byte key. (Runopenssl rand -hex 32to create a 32 byte secure random key)
3. Install and build dependencies
Make sure node version is set to 18.18.2 before running the below command:
npm install
npm install --prefix server
npm install --prefix frontend
npm run build:plugins
4. Set up database
npm run --prefix server db:create
npm run --prefix server db:migrate
If at any point you need to reset the database, use this command npm run --prefix server db:reset
5. Build client
cd ./frontend && NODE=production npm run build
6. Run server
cd ./server && npm run start:prod
The client will start on the port 3000, you can access the client by visiting the url created by codespace - https://<url>/apps/tooljet