update README.md

README.md

@@ -1,29 +1,53 @@
 # 4-GROWTH
 
-This is a mono-repo project that contains several applications, all part of the 4-GROWTH initiative. The applications are built using a variety of technologies, including TypeScript, JavaScript, and React.
+This is a mono-repo project that contains several applications, all part of the 4-GROWTH initiative. The applications are built using a variety of technologies.
 
-## Applications
+## Monorepo Structure
 
-The repository includes the following applications:
+The repository is structured as a monorepo, with each application residing in its own directory. We also have a `shared` directory that contains code shared across the applications. The `shared` directory is a dev dependency for the `client` application and a dependency for the `api` application.
+
+Here is the directory structure:
 
 - `api`: This is the backend application, built with NestJS.
 - `client`: This is the frontend application, built with React.
-
-TODO: Add the following applications to the list:
-- `admin`: This is the admin panel
+- `shared`: This directory contains shared code used by the other applications.
 
 ## Package Manager
 
 We use `pnpm` for managing packages in this project. This allows us to efficiently share common dependencies across the different applications in the mono-repo.
 
-## Mono-repo Architecture
+## Scripts
 
-The mono-repo architecture allows us to keep all our related applications in one place, making it easier to share code and manage dependencies. Each application resides in its own directory and has its own `package.json` file.
+Here are the npm scripts that you can run:
 
-## Scripts
+- `pnpm start:api:dev`: Starts the backend application in development mode.
+- `pnpm start:client:dev`: Starts the frontend application in development mode.
+- `pnpm install:client`: Installs the client application dependencies.
+- `pnpm install:api`: Installs the API application dependencies.
+- `pnpm build:client`: Builds the client application for production.
+- `pnpm build:api`: Builds the API application for production.
+- `pnpm start:client:prod`: Starts the client application in production mode.
+- `pnpm start:api:prod`: Starts the API application in production mode.
+- `pnpm start:prod`: Builds and starts both applications in production mode.
+
+## TypeScript Configuration
+
+The TypeScript configuration is defined in the `tsconfig.json` file at the root of the project. This file includes compiler options and paths for TypeScript to follow when compiling the code.
+
+The `compilerOptions` section includes settings such as the target JavaScript version, module system, and whether to emit JavaScript files. The `paths` section is used to map certain import paths to their corresponding locations in the project, which is particularly useful in a monorepo setup.
+
+Each application also has its own `tsconfig.json` file that extends the root configuration and includes application-specific settings.
+
+Please refer to the TypeScript documentation for more details on the various compiler options and how to use them.
+
+## TODO
+
+There are several aspects of the project that still need to be documented:
+
+- **Testing Procedures**: Explain how to run unit tests, integration tests, and end-to-end tests. Include information about any testing frameworks or libraries used.
+
+- **Deployment Procedures**: Describe the steps to deploy the applications in different environments (development, staging, production). Include any necessary commands, environment variables, or configuration files.
 
-Here are some of the npm scripts that you can run:
+- **Infrastructure Setup**: Provide details about the infrastructure that supports the applications. This could include servers, databases, cloud services, and networking components. Include instructions for setting up and managing these resources.
 
-- `pnpm start:api`: Starts the backend application
-- `pnpm start:client`: Starts the application in watch mode
-- `pnpm install`: Install all dependencies
+- **Additional Documentation**: There may be other aspects of the project that are not yet fully documented. Identify these areas and add them to the list of tasks.