Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (43 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 1.31 KB
Raw

Contributing to Marshant Feature Flag

Thank you for your interest in contributing to Marshant Feature Flag! This guide will help you get started with the development environment.

Prerequisites

  • Node.js (LTS version recommended)
  • pnpm package manager

Setting up the Project

1. Enable Corepack

First, enable corepack to ensure the correct package manager version is used:

corepack enable

2. Install Dependencies

Install all dependencies using pnpm:

pnpm install

3. Run Development Server

Launch compose services:

docker-compose up -d

Configure environment variables in .env files in services.

Start the development server:

pnpm dev

The application will be available at http://localhost:3005.

Container Environment

Build the Docker Image

Build the image from the project root:

docker build -t marshant-web --target web .

Run the Container

Run the Docker container:

docker run --rm -p 3005:3005 -e PORT=3005 --name marshant-web marshant-web

The application will be available at http://localhost:3005.

Usage Examples

See HTTP examples for API usage examples.

Getting Help

If you encounter any issues or have questions, please open an issue on GitHub.