Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
axelstudios committed Jan 14, 2025
1 parent c42b5ed commit 2f0fb6e
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# SEED Angular

## Prerequisites
- Node v22+
- [pnpm](https://pnpm.io/installation)

## Setup
1. Install Node v22 or newer
2. Install pnpm globally: `npm i -g pnpm`
3. Install the project dependencies: `pnpm i`

## Run
1. Run `pnpm start`
2. Browse to [localhost:4200](http://localhost:4200)

## Lint
1. Run `pnpm lint`, or `pnpm lint:fix` to automatically fix issues

## Update Translations
1. Create a `.env` file in the root of the project directory that matches the format of `.env.example`, and add your Lokalise API key
2. Run `pnpm update-translations`

## Coding Standards
Refer to [DEVELOPER.md](DEVELOPER.md) for all coding standards and guidelines.

0 comments on commit 2f0fb6e

Please sign in to comment.