Update README file

.github/workflows/ci.yml

@@ -15,6 +15,7 @@ env:
 jobs:
   test:
     name: Run tests
+    environment: 'test'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

README.md

@@ -2,9 +2,82 @@
 
 The AI chatbot will be white-labeled, allowing for full customization to meet the needs of any company. The chatbot will be integrated with Facebook Messenger, WhatsApp, and a custom chat window that can be embedded into company websites.
 
-Useful Resources and Links
+## Built with
+[![React][react-shields]][react-url] [![Vite][vite-shields]][vite-url] [![Typescript][typescript-shields]][typescript-url]
 
-* Board board: https://github.com/orgs/toggle-corp/projects/36
-* Timeline: 
-* Figma: 
-* Local Deployment: 
+## Getting started
+
+Below are the steps to guide you through preparing your local enviroment for the AI CHATBOT CMS. Before diving into setup please look into the concept of [Github Sub Modules](https://github.blog/open-source/git/working-with-submodules/), [Docker Merge](https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/).
+
+### Prerequisites
+
+To begin, ensure you have network access. Then, you'll need the following:
+    1. [Git](https://git-scm.com/)
+    2. [Node.JS](https://nodejs.org/en/) version >=18 / 20+
+    3. [Pnpm](https://pnpm.io/)
+    4. Alternatively, you can use [Docker](https://www.docker.com/) to build the application.
+
+### Local development (with docker)
+
+Clone the repository using HTTPS, SSH, or Github CLI
+```bash
+git clone https://github.com/toggle-corp/ai-chatbot-cms.git #HTTPS
+git clone [email protected]:toggle-corp/ai-chatbot-cms.git #SSH
+gh repo clone toggle-corp/ai-chatbot-cms #Github CLI
+```
+Download the contents of backend(ai-chatbot-backend)
+```bash
+git submodule update --init --recursive
+```
+Update Environment variables
+* create .env file and add COMPOSE_FILE variable for the ai-chatbot-cms
+```bash
+touch .env
+```
+* Copy env.example to .env and update the variables for the backend
+```bash
+cd backend
+cp env.example .env
+```
+> NOTE: The backend has a higher priority than the ai-chatbot-cms. You can add backend environment variables in the CMS, but you must create a .env file in the backend for them to work.
+
+Build the docker image
+```bash
+docker compose build
+```
+Start the development server
+```bash
+docker compose up
+```
+Install the dependencies
+```bash
+docker compose exec react bash -c 'pnpm install'
+```
+Generate type
+```bash
+docker compose exec react bash -c 'pnpm generate:type'
+```
+### Local development (without docker)
+
+Same steps upto downloading the contents of backend
+
+Update Enviroment variables
+
+* create .env file and add COMPOSE_FILE and other variable for the ai-chatbot-cms
+```bash
+touch .env
+```
+> NOTE: Copy the env variables from the docker compose file in environment section
+
+Install the dependencies
+```bash
+pnpm install
+```
+Generate type
+```bash
+pnpm generate:type
+```
+Start the development server
+```bash
+pnpm start
+```

env.ts

@@ -5,8 +5,8 @@ import {
 
 export default defineConfig({
     // NOTE: We need to replace with URL
-    APP_GRAPHQL_ENDPOINT: Schema.string.optional(),
+    APP_GRAPHQL_ENDPOINT: Schema.string(),
 
     // NOTE: It is not used for now
-    APP_TITLE: Schema.string.optional(),
+    APP_TITLE: Schema.string(),
 });

package.json

@@ -24,9 +24,9 @@
     },
     "dependencies": {
         "@apollo/client": "^3.11.8",
-        "@togglecorp/fujs": "^2.0.0",
-        "@julr/vite-plugin-validate-env": "^1.1.1",
         "@graphql-typed-document-node/core": "^3.2.0",
+        "@julr/vite-plugin-validate-env": "^1.1.1",
+        "@togglecorp/fujs": "^2.0.0",
         "graphql": "^16.9.0",
         "react": "^18.2.0",
         "react-dom": "^18.2.0",