Skip to content

Development Setup

Nguyễn Xuân Nhân edited this page Dec 21, 2023 · 1 revision

Configure Docker Desktop

Docker Desktop allows you to enable Kubernetes, which can be beneficial for deploying and managing containers. To enable Kubernetes:

  • Open Docker Desktop settings.
  • Navigate to the "Kubernetes" tab.
  • Check the box to enable Kubernetes and apply the settings.

image

Note:

If you intend to run a database within a containerized environment, please be aware that the application utilizes separate containers for PostgreSQL, Redis, and Grafana Loki. The PostgreSQL container accommodates four databases for replication purposes, while the Redis container employs three databases to support high availability. It's essential to consider the significant memory requirements associated with these containers.

Setting Up Your Workspace

To set up an NX workspace that includes React.js, Nest.js, Python, and .Net, follow these steps:

  1. Install Node.js: Ensure you have Node.js installed on your system. If not, download and install it from the official Node.js website.

  2. Install pnpm (Optional): Yarn is a package manager that works well with NX. You can install it globally by following the instructions on the pnpm website.

  3. Install the NX CLI: Install the NX CLI globally using npm or Yarn by running the following command in your terminal:

npm install -g nx

# or
pnpm global add nx

Use Visual Studio Code

To work with this project, follow these steps:

  1. Install Visual Studio Code (VS Code):

    • If you don't already have VS Code installed, you can download and install the latest release from the official VS Code website.
  2. Install Required Extensions:

    • After installing VS Code, you'll want to install some extensions to enhance your development experience. Open VS Code, and in the Extensions view (you can access it by clicking the square icon on the left sidebar), search for and install the following extensions:
  3. Install or Update Node.js, .Net, and Python:

    • Ensure that you have the latest versions of Node.js, Flutter, and Python installed on your system. You can download and install them from their respective official websites:
  4. Open Your Project in VS Code:

    • Open VS Code and use the "Open Folder" option to open your project directory.
  5. Start Coding:

    • You're now ready to start coding and developing your project using the enhanced capabilities of Visual Studio Code and the installed extensions.

By following these steps and installing the necessary extensions, you'll have a more productive development environment for working with Node.js, .Net, Python, Docker and Kubernetes within Visual Studio Code.

Use Gitpod

Open in Gitpod

You can use Gitpod to work with this project. To do so, follow these steps:

  1. Create a Gitpod Account:
    • If you don't already have a Gitpod account, you can create one by visiting the Gitpod website.
    • You can also sign up for Gitpod using your GitHub account.
  2. Install the Gitpod Browser Extension:
    • After creating your Gitpod account, you'll need to install the Gitpod browser extension. You can find the extension for your browser on the Gitpod website.
  3. Open Your Project in Gitpod:
    • Once you've installed the Gitpod browser extension, you can open your project in Gitpod by clicking the Gitpod button in the top right corner of your GitHub repository.

By following these steps, you'll be able to work with this project in Gitpod.

Use GitHub Codespaces

You can use GitHub Codespaces to work with this project. To do so, follow these steps:

  1. Create a GitHub Account:
    • If you don't already have a GitHub account, you can create one by visiting the [GitHub website](
  2. Create a Codespace:
    • After creating your GitHub account, you can create a Codespace by clicking the "Code" button in the top right corner of your GitHub repository and selecting "New Codespace" from the dropdown menu.
  3. Open Your Codespace:
    • Once you've created your Codespace, you can open it by clicking the "Code" button in the top right corner of your GitHub repository and selecting "Open with Codespaces" from the dropdown menu.
    • You can also open your Codespace by clicking the "Codespaces" tab in your GitHub repository and selecting "Open Codespace" from the dropdown menu.

By following these steps, you'll be able to work with this project in GitHub Codespaces.