generated from nhcarrigan/template
docs: refresh eclaire docs and version badge
This commit is contained in:
@@ -673,7 +673,7 @@ export const navigation = [
|
|||||||
{
|
{
|
||||||
label: "Eclaire",
|
label: "Eclaire",
|
||||||
link: "/projects/eclaire",
|
link: "/projects/eclaire",
|
||||||
badge: { text: "v1.0.0", variant: "tip" },
|
badge: { text: "v1.1.0", variant: "tip" },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "freeCodeCamp Review Generator",
|
label: "freeCodeCamp Review Generator",
|
||||||
|
|||||||
@@ -10,13 +10,13 @@ This section is for those interacting with a live instance of the Application.
|
|||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
1. **Initial Setup**: Navigate to the Configuration page to set up your API credentials and language preferences.
|
1. **Initial Setup**: Open the configuration screen and provide your API credentials and language preferences.
|
||||||
|
|
||||||
2. **Configuration Options**:
|
2. **Configuration Options**:
|
||||||
- **Deepgram API Key**: Required for speech-to-text transcription. You must provide your own API key from [Deepgram](https://deepgram.com).
|
- **Deepgram API Key**: Required for speech-to-text transcription.
|
||||||
- **Translation Service API Key**: Required for text translation. A demo key is available with a 10 requests/minute rate limit, or you can provide your own key.
|
- **Translation Service API Key**: Required for text translation. The application includes a built-in demonstration key in source comments with a 10 requests/minute limit.
|
||||||
- **Source Language**: Select from 12 supported languages (English, German, Dutch, Swedish, Danish, Spanish, French, Portuguese, Italian, Turkish, Norwegian, Indonesian).
|
- **Source Language**: Selected from the source-language allow-list defined in the configuration component.
|
||||||
- **Target Language**: Select from 60+ supported languages for translation.
|
- **Target Language**: Selected from the language-code mapping list used by the configuration component.
|
||||||
|
|
||||||
3. **Using the Translation Interface**:
|
3. **Using the Translation Interface**:
|
||||||
- Navigate to the Agent page to begin translation.
|
- Navigate to the Agent page to begin translation.
|
||||||
@@ -43,10 +43,9 @@ The application automatically enables:
|
|||||||
|
|
||||||
### Limitations
|
### Limitations
|
||||||
|
|
||||||
- Source language is limited to 12 languages supported by Deepgram
|
- Requires a modern browser with microphone access.
|
||||||
- Translation service demo key has a rate limit of 10 requests/minute
|
- Requires a WebSocket connection for real-time transcription.
|
||||||
- Requires modern browser with microphone access
|
- Translation demo key usage is rate limited.
|
||||||
- WebSocket connection required for real-time functionality
|
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
@@ -70,17 +69,17 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
|
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
```bash
|
```bash
|
||||||
npm install
|
pnpm install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Start the development server:
|
3. Start the development server:
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
pnpm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Build for production:
|
4. Build for production:
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
pnpm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Technology Stack
|
### Technology Stack
|
||||||
@@ -88,7 +87,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
**Frontend Framework:**
|
**Frontend Framework:**
|
||||||
- Angular 19.1.4 with standalone components
|
- Angular 19.1.4 with standalone components
|
||||||
- TypeScript 5.7.3
|
- TypeScript 5.7.3
|
||||||
- RxJS 7.8.1 for reactive programming
|
- RxJS 7.8.2 for reactive programming
|
||||||
- Angular Reactive Forms for configuration management
|
- Angular Reactive Forms for configuration management
|
||||||
|
|
||||||
**External APIs:**
|
**External APIs:**
|
||||||
@@ -144,8 +143,7 @@ This section is for those interested in running their own instance of the Applic
|
|||||||
|
|
||||||
#### Routing
|
#### Routing
|
||||||
|
|
||||||
- `/` - Redirects to home
|
- `/` - Home page
|
||||||
- `/home` - Landing page
|
|
||||||
- `/config` - Configuration page
|
- `/config` - Configuration page
|
||||||
- `/agent` - Translation interface
|
- `/agent` - Translation interface
|
||||||
|
|
||||||
@@ -192,9 +190,9 @@ POST request body:
|
|||||||
|
|
||||||
#### Available Scripts
|
#### Available Scripts
|
||||||
|
|
||||||
- `npm run dev` - Start development server
|
- `pnpm run dev` - Start development server
|
||||||
- `npm run lint` - Run ESLint with zero warnings policy
|
- `pnpm run lint` - Run ESLint with zero warnings policy
|
||||||
- `npm run build` - Build for production
|
- `pnpm run build` - Build for production
|
||||||
|
|
||||||
#### Code Quality
|
#### Code Quality
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user