Skip to content

Latest commit

 

History

History
103 lines (86 loc) · 2.6 KB

README.md

File metadata and controls

103 lines (86 loc) · 2.6 KB
Raw

sanctuaryteam/diablotrading-fe

diablo4.trading frontend application

Windows Installation

Follow this setup guide - Windows Setup Instructions

Set Up .env

Docker will user this file for project specific environment variables

  • Create a new GitHub personal access token with the following scopes: read:packages

  • Update .env File: run cp .env.example .env to create a new .env file. Update the new .env file with SANCTUARYTEAM_AUTH_TOKEN=YOUR_NEW_TOKEN

Running the Application with Docker

To get your application up and running:

  • Ensure you have both Docker and Docker Compose installed.
  • Navigate to the directory containing your docker-compose.yml file.
 cd ~/sanctuaryteam/diablo4trading-fe
  • Run the following command: docker compose up
  • Access the Application: Once the containers are up and running, you can access the application in your browser using the URL: http://localhost:5173

Development

start - Starts the application in development mode.

 yarn run start

start:dev - Starts the application in development mode with watch enabled.

 yarn run start:dev

start:prod - Starts the application in production mode.

 yarn run start:prod

dev - Starts the Vite development server.

 yarn run dev

preview - Previews the production build using Vite.

 yarn run preview

tsc - Runs TypeScript compiler (tsc) without emitting any files.

 yarn run tsc

Translation

lingui:extract - Extracts translations with LinguiJS, and removes obsolete translations.

 yarn run lingui:extract

lingui:compile - Compiles translations with LinguiJS and outputs TypeScript files.

 yarn run lingui:compile

Build & Deployment

prebuild - Compiles translations before building.

 yarn run prebuild

build - Compiles TypeScript and then builds the project using Vite.

 yarn run build

Code Quality (Linting & Formatting)

lint - Lints TypeScript files with ESLint.

 yarn run lint

format - Formats the code using dprint.

 yarn run format

Testing

test - Runs both unit and UI tests.

 yarn run test

test:unit - Runs unit tests with Jest using a specific configuration.

 yarn run test:unit

test:ui - Runs UI tests with Jest using a specific configuration.

 yarn run test:ui

test:coverage - Runs unit tests with Jest, generating coverage information.

 yarn run test:coverage