Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 2.13 KB

README.md

File metadata and controls

89 lines (64 loc) · 2.13 KB
Raw

Kogen

Kogen is a project that utilizes npm workspaces to manage multiple packages within a single repository.

Table of Contents

Project Structure

The project is organized using npm workspaces, with the following structure:

kogen/
├── package.json
├── package/
│   └── ui/
│       ├── .env.example
│       ├── package.json
│       └── ...
└── ...

Workspaces

This project uses npm workspaces, which is a feature that allows you to manage multiple packages within a single repository. Workspaces offer several benefits:

  1. Simplified dependency management: Shared dependencies are hoisted to the root, reducing duplication and saving disk space.
  2. Cross-package development: You can easily work on and test multiple packages simultaneously.
  3. Consistent versioning: Ensures all packages use the same version of shared dependencies.

In this project, we have a workspace called @kogen/kogen-ui located in the package/ui directory.

Getting Started

Prerequisites

  • Node.js (version 12.22.9 or higher)
  • npm (version 8.19.3 or higher)

Installation

  1. Clone the repository:

    git clone https://github.com/kogen-markets/app.git
cd app

  2. Set up the environment for the UI package:

    cp package/ui/.env.example package/ui/.env

  3. Install dependencies:

    npm i

Development

To start the development server for the UI package:

npm -w @kogen/kogen-ui run dev

This command uses the -w flag to specify the workspace package you want to run the script in.

Testing Production Build

To build and serve the production version of the UI package:

  1. Build the production version:

    npm run -w @kogen/kogen-ui build:prod

  2. Serve the built files:

    npx serve package/ui/dist