Skip to content

Latest commit

 

History

History
108 lines (87 loc) · 4.51 KB

README.md

File metadata and controls

108 lines (87 loc) · 4.51 KB
Raw

Climsoft-Web

Overview

Climsoft Web is a comprehensive web application featuring both frontend and backend components. The frontend is developed with Angular, while the backend leverages NestJS and PostgreSQL for a robust, full-stack solution.

Development Deployment Guide

To deploy the Climsoft Web application for development purposes, follow these steps:

Prerequisites

  • Ensure Docker Desktop is downloaded and installed on your machine.
  • Start the Docker engine via the Docker Desktop application.
  • Ensure Node.js is downloaded and installed on your machine.
  • Ensure Git is downloaded and installed on your machine.
  • For CI/CD(continuous integration and development) workflows, use visual studio code to execute set up commands, pull and push latest changes.

Setup

  1. Clone the Repository: Execute the following command to Clone Climsoft Web to your local machine using the command:

    git clone https://github.com/climsoft/climsoft-web.git

  2. Start PostgreSQL: Within the cloned repository directory, execute the following command to initialise the PostgreSQL container:

    docker-compose -f docker-compose.dev.yaml up

  3. Backend API Setup: Navigate to back-end/api and run the commands below to install NestJS dependencies, launch the backend API with hot-reload enabled and execute seeding migration scripts:

    npm install
    nest start --watch

  4. Frontend Setup: In the front-end/pwa directory, execute the following commands to install Angular dependencies and launch the development server:

    npm install
    ng serve

  5. Access the Application: Open a web browser and go to http://localhost:4200/ to view the application.

Testing Deployment Guide

For testing deployment with Docker containers for PWA, API and PostgreSQL, follow these steps:

Prerequisites

  • Make sure Docker Desktop is downloaded and installed on your machine.
  • Activate the Docker engine using the Docker Desktop application.
  • Ensure Git is downloaded and installed on your machine.
  • For CI/CD(continuous integration and development) workflows, we recommend using GitHub Desktop to pull latest changes.

Setup

  1. Clone the Repository: Clone Climsoft Web to your machine:

    git clone https://github.com/climsoft/climsoft-web.git

  2. Initialise Containers: Within the cloned repository directory, execute the following command to initialise the PWA, API and PostgreSQL containers:

    docker-compose -f docker-compose.test.yaml up

  3. Access the Application: Navigate to http://localhost:4200/ in your web browser to interact with the application.

  4. Stopping the Application: Within the cloned repository directory, execute the following command to stop the PWA, API and PostgreSQL containers:

    docker-compose -f docker-compose.test.yaml down

Production Deployment Guide

For production deployment with Docker containers for PWA, API and PostgreSQL, follow these steps:

Prerequisites

  • Make sure Docker Desktop is downloaded and installed on your machine.
  • Activate the Docker engine using the Docker Desktop application.

Setup

  1. Download required files: Download docker-compose.prod.yaml and .env files.

  2. Edit .env file Replace the contents of the file with your specific settings.

  3. Initialise Containers: Within the cloned repository directory, execute the following command to initialise the PWA, API and PostgreSQL containers:

    docker-compose -f docker-compose.prod.yaml up

  4. Access the Application: Navigate to http://localhost:4200/ in your web browser to interact with the application.

  5. Stopping the Application: Within the cloned repository directory, execute the following command to stop the PWA, API and PostgreSQL containers:

    docker-compose -f docker-compose.prod.yaml down