Skip to content

Commit 4b114b5

Browse files
authored
Merge pull request #165 from SELISEdigitalplatforms/Updating-Readme
Update README.md
2 parents 978fd70 + 927b768 commit 4b114b5

1 file changed

Lines changed: 105 additions & 126 deletions

File tree

README.md

Lines changed: 105 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -2,193 +2,172 @@
22

33
SELISE `<blocks/>` Construct is a fully functional application blueprint designed to accelerate development with **SELISE `<blocks />`**. Pre-integrated with SELISE `<blocks />` microservices, it offers a seamless full-stack foundation, complete with essential features, prebuilt modules, and practical use cases. Whether starting fresh or enhancing an existing project, **SELISE Blocks Construct** provides a scalable framework that streamlines workflows, ensures best practices, and maximizes **SELISE `<blocks />`'** capabilities.
44

5+
## Live Links
56

6-
### 🌍 Live Links
7+
- **SELISE `<blocks />` Construct**[construct.seliseblocks.com](https://construct.seliseblocks.com)
8+
- **SELISE `<blocks />` Cloud App**[cloud.seliseblocks.com](https://cloud.seliseblocks.com)
79

8-
*SELISE `<blocks />` Construct* - https://construct.seliseblocks.com
10+
## Other Links
911

10-
*SELISE `<blocks />` Cloud App* - https://cloud.seliseblocks.com
12+
### Frontend
1113

12-
### 🔗 Other Links
14+
- **SELISE `<blocks />` CLI (NPM)**[@seliseblocks/cli](https://www.npmjs.com/package/@seliseblocks/cli)
15+
- **GitHub Repository**[l3-react-blocks-construct](https://github.com/SELISEdigitalplatforms/l3-react-blocks-construct)
1316

14-
**Frontend**
17+
### Backend
1518

16-
SELISE `<blocks />` cli npm package - https://www.npmjs.com/package/@seliseblocks/cli
17-
18-
Open-source GitHub repo link - https://github.com/SELISEdigitalplatforms/l3-react-blocks-construct
19-
20-
**Backend**
21-
22-
SELISE `<blocks />` cli nuget package - https://www.nuget.org/packages/SeliseBlocks.CLI
23-
24-
Open-source GitHub repo link - https://github.com/SELISEdigitalplatforms/l3-net-blocks-consumer
19+
- **SELISE `<blocks />` CLI (NuGet)**[SeliseBlocks.CLI](https://www.nuget.org/packages/SeliseBlocks.CLI)
20+
- **GitHub Repository**[l3-net-blocks-consumer](https://github.com/SELISEdigitalplatforms/l3-net-blocks-consumer)
2521

2622
---
2723

24+
## Setting Up Blocks Construct Using CLI
2825

26+
<details>
27+
<summary><strong>1. Access SELISE Blocks Cloud </strong></summary>
2928

29+
### Open the Cloud App
30+
1. In your browser, go to [SELISE `<blocks />` Cloud App](https://cloud.seliseblocks.com).
3031

32+
### Create an Account
33+
1. Click **Sign Up** and follow the instructions to create an account.
34+
2. Once registered, log in with your credentials.
3135

36+
### Access the Console
37+
1. After logging in, you will land on the **Console** where you can manage projects.
3238

33-
34-
35-
## 📌 Setting Up Blocks Construct Using CLI
36-
37-
38-
### Step 1: Access SELISE `<blocks />` Cloud App's Console
39-
40-
#### Visit SELISE `<blocks />` Cloud App
41-
42-
- Open your browser and navigate to [SELISE `<blocks />` Cloud App](https://cloud.seliseblocks.com).
43-
44-
#### Sign Up for an Account
45-
46-
- Click on the **Sign Up** button to create a new account.
47-
48-
#### Log In to Your Account
49-
50-
- Once signed up, log in with your credentials and proceed to the **Console** section.
39+
</details>
5140

5241
---
5342

54-
### Step 2: Create a New Project
55-
56-
**Prerequisites:** Prerequisites: Ensure that you have a registered web domain for your application and full administrative access to its DNS settings.
43+
<details>
44+
<summary><strong>2. Create a New Project</strong></summary>
5745

58-
#### Start a New Project
46+
### Before You Begin
47+
Ensure that you:
48+
- Have a registered web domain for your application.
49+
- Have full administrative access to its DNS settings.
5950

60-
- In the **Console**, click on **Create New Project**.
51+
### Create Your Project
52+
1. In the **Console**, click **Create New Project**.
53+
2. Enter a **unique project name**.
54+
3. Select an **environment**:
55+
- Choose either **Sandbox** or **Production**.
56+
- The page will expand to display the **domain input field**.
57+
4. (Optional) Enable **Cookie Domain**:
58+
- Check the box to see the **cookie domain in use**.
59+
- Follow the provided instructions for DNS settings.
60+
5. Click **Create** to initialize the project.
61+
6. The Console will update to display your project.
6162

62-
#### Project Name (Step 1)
63-
64-
- Enter a **unique name** for your project.
65-
66-
#### Domain (Step 2)
67-
68-
- Provide the **domain** associated with your project.
69-
70-
#### Access Your Project Dashboard
71-
72-
- After creating your project, navigate to the **Project Dashboard**.
63+
</details>
7364

7465
---
7566

76-
### Step 3: Install SELISE Blocks CLI
77-
78-
#### Install SELISE Blocks CLI Globally
79-
80-
**Prerequisites:** Make sure you have NVM and Node.js (version 20.x or later) installed on your machine before proceeding with the installation.
67+
<details>
68+
<summary><strong>3. Install SELISE Blocks CLI</strong></summary>
8169

82-
**Detailed installation steps** -
70+
### Check System Requirements
71+
Ensure your system has the following installed:
8372

84-
For installing nodejs directly follow the instructions of this [link](https://nodejs.org/en/download)
85-
86-
Or,
87-
88-
To install via NVM follow this [link](https://www.freecodecamp.org/news/how-to-install-node-in-your-machines-macos-linux-windows/)
73+
- **Node.js (v20.x or later)**[Download Node.js](https://nodejs.org/en/download)
74+
- **NVM (Node Version Manager)**[Install NVM](https://www.freecodecamp.org/news/how-to-install-node-in-your-machines-macos-linux-windows/)
75+
- **Git**[Download Git](https://git-scm.com/downloads)
8976

77+
### Install SELISE Blocks CLI
78+
Run the following command in your terminal:
9079
```sh
9180
npm install -g @seliseblocks/cli
9281
```
93-
**Note:** In case you are facing any permission-related issues on your Linux/MacOS, use `sudo` before the command.
94-
95-
#### Verify the Installation (Optional)
96-
97-
![image (1)](https://github.com/user-attachments/assets/cc045c8b-01e8-431c-b958-253793baf562)
98-
99-
i) Upon running the following command if you can see the above image, your installation is successful.
100-
82+
If you encounter permission issues on Linux/macOS, use:
10183
```sh
102-
blocks
103-
84+
sudo npm install -g @seliseblocks/cli
10485
```
10586

106-
107-
ii) Run the following command to check blocks version -
108-
87+
### Verify Installation
88+
To confirm installation, run:
10989
```sh
110-
blocks v
90+
blocks
11191
```
112-
113-
---
114-
115-
### Step 4: Set Up Your Project
116-
117-
#### Create a New Project Locally
118-
92+
To check the installed version:
11993
```sh
120-
blocks new <project-name>
94+
blocks v
12195
```
12296

123-
Replace `<project-name>` with your project’s name.
124-
125-
#### Enter Your Domain
126-
127-
- When prompted, enter the domain you provided earlier.
128-
129-
#### Enter the Project Key
97+
</details>
13098

131-
- Find your **Project Key** on your **Project Dashboard** and enter it when prompted.
132-
- The GitHub repository for **SELISE Blocks Construct** will now be cloned and installed on your local machine.
99+
---
133100

101+
<details>
102+
<summary><strong>4. Create a New Project Locally</strong></summary>
134103

135-
#### Navigate to the Project Directory
104+
### Initialize the Project
105+
1. Open a terminal.
106+
2. Run the following command:
107+
```sh
108+
blocks new <project-name>
109+
```
110+
- Replace `<project-name>` with your desired folder name. The repository will be cloned into this folder.
136111

137-
```sh
138-
cd <project-name>
139-
```
112+
### Enter Project Details
113+
1. When prompted, enter the **domain** you registered earlier.
114+
2. Retrieve the **Project Key** from the **Project Dashboard**.
115+
3. Copy and paste the Project Key into the terminal when prompted.
116+
4. Configure cookies:
117+
- You will be asked whether to enable or disable cookies.
118+
- Use the **arrow keys** (Up/Down) to select your preference and press **Enter**.
119+
5. The repository will be downloaded with your project configured.
140120

141-
Replace `<project-name>` with your actual project’s name.
121+
</details>
142122

143123
---
144124

145-
### Step 5: Start SELISE Blocks Construct
125+
<details>
126+
<summary><strong>5. Start SELISE Blocks Construct</strong></summary>
146127

147-
#### Launch the Application
148-
149-
To run the project using localhost, use:
128+
### Navigate to the Project Directory
129+
1. In your terminal, navigate to the project folder:
130+
```sh
131+
cd <project-name>
132+
```
133+
Replace `<project-name>` with the actual project name.
150134

135+
### Start the Application Locally
136+
Run the following command to start the project:
151137
```sh
152138
npm start
153139
```
154140

155-
Or,
156-
157-
To run the project using your application domain -
158-
159-
i) You will need to add an entry for your application domain in the hosts file of your machine. How to give entry in the hostfile? [Please read this](https://www.manageengine.com/network-monitoring/how-to/how-to-add-static-entry.html)
160-
161-
ii) Register your site on Google reCAPTCHA [here](https://www.google.com/recaptcha/admin/create)
162-
and update the siteKey property of the components where reCAPTCHA has been integrated accordingly in the construct project.
163-
164-
165-
Then, use:
141+
### Run Using Your Application Domain
142+
1. Add an entry for your domain in the **hosts file** of your machine. Follow [this guide](https://www.manageengine.com/network-monitoring/how-to/how-to-add-static-entry.html) for instructions.
143+
2. Register your site on **Google reCAPTCHA** by visiting [this page](https://www.google.com/recaptcha/admin/create).
144+
3. Update the `siteKey` value in your project wherever reCAPTCHA is integrated.
166145

146+
Then, run:
167147
```sh
168148
npm run start:local
169149
```
170150

171-
- The **login page** for your project should now appear.
172-
173-
---
174-
175-
### Step 6: Create and Log In
176-
177-
#### Create a User on SELISE `<blocks />` Cloud App
178-
179-
- If you haven't already, invite a user from User Management Service on the [**SELISE `<blocks />` Cloud App**](https://cloud.seliseblocks.com/) application.
151+
The **login page** should now be accessible.
180152

181-
![Screenshot 2025-01-29 at 11 30 28 AM](https://github.com/user-attachments/assets/96185c96-a2e3-4502-8124-29a18f0ad30b)
153+
</details>
182154

183-
An activation email will be sent to the user's email for your project portal. Upon clicking it, the user will be able to set a password for the portal, and their account will be activated.
184-
185-
#### Log In to SELISE Blocks Construct
155+
---
186156

187-
- Use your new credentials to log in to [**SELISE Blocks Construct**](https://construct.seliseblocks.com).
157+
<details>
158+
<summary><strong>6. Create and Log In</strong></summary>
188159

160+
### Create a User
161+
1. In the **User Management Service** on [SELISE `<blocks />` Cloud App](https://cloud.seliseblocks.com/), invite a new user.
162+
2. The user will receive an activation email.
163+
3. They must click the activation link and set a password.
189164

165+
### Log In to SELISE Blocks Construct
166+
- Go to your application's domain (the one you entered earlier) or use `localhost` if running locally, and log in using the newly created credentials.
190167

168+
</details>
191169

192-
## 🎯 You're all set!
170+
---
193171

194-
Now, you can start building and customizing your application using **SELISE Blocks Construct**. 🚀
172+
## Next Steps
173+
You are now ready to start building and customizing your application with **SELISE Blocks Construct**.

0 commit comments

Comments
 (0)