Getting Started

Getting Started

MyShip is an npm workspaces monorepo with two main apps: a server (gateway) and a client.

Prerequisites

• Node.js (LTS) and npm
• Git

Install

git clone https://github.com/MyShipDE/myship.git
cd myship
# Install all workspace dependencies from the repo root
npm install

Run

# Server (gateway)
npm run server:start

# Client (Angular dev server on http://localhost:4200)
npm run client:start

# Production build of the client
npm run client:build

Configure

Each app is configured via a local .env file. Copy the templates and fill in your own values:

cp apps/server/.env.example apps/server/.env
cp apps/client/electron/deploy/.env.example apps/client/electron/deploy/.env

See Configuration for details.