https://github.com/dreamfactorysoftware/df-admin-interface
https://github.com/dreamfactorysoftware/df-admin-interface
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dreamfactorysoftware/df-admin-interface
- Owner: dreamfactorysoftware
- License: apache-2.0
- Created: 2023-07-31T18:34:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T02:05:11.000Z (about 1 year ago)
- Last Synced: 2024-05-28T11:59:40.967Z (about 1 year ago)
- Language: TypeScript
- Size: 34.6 MB
- Stars: 1
- Watchers: 6
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - dreamfactorysoftware/df-admin-interface - (TypeScript)
README
# DreamFactory Admin Interface
Admin interface for managing DreamFactory instance.
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Linting and Formatting](#linting-and-formatting)
- [Lint](#lint)
- [Lint and Fix](#lint-and-fix)
- [Format](#format)
- [Running the tests](#running-the-tests)
- [Run Unit Tests](#run-unit-tests)
- [Run and Watch Unit Tests](#run-and-watch-unit-tests)
- [Run Unit Tests with Coverage](#run-unit-tests-with-coverage)
- [Building the Project](#building-the-project)
- [Adding additional languages](#adding-additional-languages)
## Getting Started
### Prerequisites
- Node.js >=16.14.0
- Angular CLI
### Installation
```
npm install
```
#### Install husky
[husky](https://typicode.github.io/husky/) is used to run git hooks for formatting and linting checking code prior to commiting code. To install husky run the following command:
```
npm run prepare
```
## Usage
### Development
```
npm start
```
Proxying to DreamFactory instance is configured in [proxy.conf.json](./proxy.conf.json).
### Linting and Formatting
#### Lint
```
npm run lint
```
#### Lint and Fix
```
npm run lint:fix
```
#### Format
```
npm run prettier
```
## Running the tests
[jest](https://jestjs.io/) is used for unit testing. Tests are named with the following convention: [name].spec.ts
#### Run Unit Tests
```
npm run test
```
#### Run and Watch Unit Tests
```
npm run test:watch
```
#### Run Unit Tests with Coverage
```
npm run test:coverage
```
## Building the Project
```
npm run build
```
## Adding additional languages
When more than one language is supported, the language selector will be displayed in the top right corner of the application.
- User language will be detected from preference provided by browser. If browser preference is a supported language it will be selected by default.
- If language selector is enabled and user change language manually, their preference is stored in `localStorage` for future reference. If language preference is found in `localStorage`, than it is treated as default language.
- To add a new language, follow these steps:
1. Add a new entry to the `SUPPORTED_LANGUAGES` array in [src/app/shared/constants/languages.ts](src/app/shared/constants/languages.ts).
- code: The language code. This is used to identify the language in the application.
- altCode: Alternative language code that might be provided by browser. eg en-US, en-CA.
2. Create new translation files in [src/assets/i18n](./src/assets/i18n/) and every sub-folder.
- Ensure label for languages are created in alternative language in [src/assets/i18n/en.json](src/assets/i18n/en.json)
```json
"languages": {
"en": "English"
}
```
- These are used to display language label in dropdown.