From a8ced6e9ebcdd98a0a9664f666b0928147499dc7 Mon Sep 17 00:00:00 2001 From: Prachi <94190717+Prachi-Jamdade@users.noreply.github.com> Date: Sun, 14 Jul 2024 21:19:01 +0530 Subject: [PATCH 1/2] fix: invalid command to install PostgREST [docs] --- .../contributing-guide/setup/macos.md | 27 ++++++++++++------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md b/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md index 049a6712fa..b70dbfc31d 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md +++ b/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md @@ -40,10 +40,17 @@ To set up and run ToolJet on macOS for development, begin by opening your termin :::info Required only if ToolJet Database is being used. - ::: + ::: + + To install a specific version of PostgRest using Homebrew: ```bash - brew install postgrest + brew install postgrest@ + ``` + To find out which versions are available, you can search with: + + ```bash + brew search postgrest ``` 1.5 Clone the repository @@ -51,14 +58,14 @@ To set up and run ToolJet on macOS for development, begin by opening your termin git clone https://github.com/tooljet/tooljet.git ``` -2. Set up environment variables +3. Set up environment variables Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/setup/env-vars) ```bash cp .env.example .env ``` -3. Populate the keys in the env file +4. Populate the keys in the env file :::info `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key) @@ -81,7 +88,7 @@ To set up and run ToolJet on macOS for development, begin by opening your termin ORM_LOGGING=all ``` -4. Install and build dependencies +5. Install and build dependencies ```bash npm install npm install --prefix server @@ -89,7 +96,7 @@ To set up and run ToolJet on macOS for development, begin by opening your termin npm run build:plugins ``` -5. Set up database +6. Set up database ```bash npm run --prefix server db:create npm run --prefix server db:reset @@ -98,24 +105,24 @@ To set up and run ToolJet on macOS for development, begin by opening your termin If at any point you need to reset the database, use this command `npm run --prefix server db:reset` ::: -6. Run plugins compilation in watch mode +7. Run plugins compilation in watch mode ```bash cd ./plugins && npm start ``` -7. Run the server +8. Run the server ```bash cd ./server && npm run start:dev ``` -8. Run the client +9. Run the client ```bash cd ./frontend && npm start ``` The client will start on the port 8082, you can access the client by visiting: [http://localhost:8082](http://localhost:8082) -9. Create login credentials +10. Create login credentials Visiting [http://localhost:8082](http://localhost:8082) should redirect you to the login page, click on the signup link and enter your email. The emails sent by the server in development environment are captured and are opened in your default browser. Click the invitation link in the email preview to setup the account. From 73dd6149329aa522f1b24c7efd10c7626b99e281 Mon Sep 17 00:00:00 2001 From: Prachi <94190717+Prachi-Jamdade@users.noreply.github.com> Date: Mon, 15 Jul 2024 14:49:21 +0530 Subject: [PATCH 2/2] [doc]: add postgrest start and brew services list commands These additions will help users: - Start the PostgREST service easily with `brew services start postgrest` - Verify the status of the PostgREST service and other services using `brew services list` --- .../contributing-guide/setup/macos.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md b/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md index b70dbfc31d..a4d2171790 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md +++ b/docs/versioned_docs/version-2.50.0-LTS/contributing-guide/setup/macos.md @@ -53,6 +53,18 @@ To set up and run ToolJet on macOS for development, begin by opening your termin brew search postgrest ``` + Once PostgREST is installed, you can start the PostgREST service using Homebrew services: + + ``` + brew services start postgrest + ``` + + Run the following command to check the status of the PostgREST service and other Homebrew-managed services: + + ``` + brew services list + ``` + 1.5 Clone the repository ```bash git clone https://github.com/tooljet/tooljet.git