cli/pkg/i18n/docs/getting-started.md
Snider 4e02d5bc97 refactor: bring external packages home and restructure
- Imported packages from separate repos:
  - github.com/Snider/config -> pkg/config
  - github.com/Snider/display -> pkg/display
  - github.com/Snider/help -> pkg/help
  - github.com/Snider/i18n -> pkg/i18n
  - github.com/Snider/updater -> pkg/updater
- Moved core code from root to pkg/core
- Flattened nested package structures
- Updated all import paths to github.com/Snider/Core/pkg/*
- Added Display interface to Core
- Updated go.work for workspace modules

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-15 15:30:43 +00:00

1.5 KiB

Getting Started

This guide will help you set up and run the i18n project on your local machine.

Prerequisites

Before you begin, ensure you have the following installed:

  • Go (version 1.16 or later recommended)
  • Node.js and npm (for the frontend)

Installation

  1. Clone the repository:

    git clone https://github.com/snider/i18n.git
    cd i18n
    
  2. Install Go dependencies:

    go mod tidy
    
  3. Install Frontend dependencies:

    Navigate to the ui directory and install the npm packages:

    cd ui
    npm install
    cd ..
    

Running the Application

The application consists of a Go backend and an Angular frontend. You can run them together using the serve command.

  1. Build the Frontend:

    First, you need to build the Angular application so that the Go server can serve the static files.

    cd ui
    npm run build
    cd ..
    
  2. Start the Server:

    Run the Go application using the serve command:

    go run ./cmd/i18n serve
    

    You should see output indicating that the server is listening on port 8080:

    Listening on :8080...
    
  3. Access the Application:

    Open your web browser and navigate to http://localhost:8080. You should see the i18n-element application running.

    There is also a demo API endpoint available at http://localhost:8080/api/v1/demo.