Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trustlelab/siteware-frontend-v2
Siteware - German Voice AI Agent provider frontend - Deepgram + Twilio + Elevenlabs + OpenAI + Pinecone
https://github.com/trustlelab/siteware-frontend-v2
eslint figma javascript react tailwindcss typescript webpack
Last synced: 23 days ago
JSON representation
Siteware - German Voice AI Agent provider frontend - Deepgram + Twilio + Elevenlabs + OpenAI + Pinecone
- Host: GitHub
- URL: https://github.com/trustlelab/siteware-frontend-v2
- Owner: trustlelab
- Created: 2024-11-20T18:03:33.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-20T18:23:46.000Z (3 months ago)
- Last Synced: 2024-11-20T19:23:06.823Z (3 months ago)
- Topics: eslint, figma, javascript, react, tailwindcss, typescript, webpack
- Language: TypeScript
- Homepage: https://sw-frontend-lyart.vercel.app/
- Size: 775 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Siteware Frontend
=======
**Edit a file, create a new file, and clone from Bitbucket in under 2 minutes**
## Overview
**Siteware Frontend** is the frontend of an AI-powered voice agent platform built using **Vite**, **TypeScript**, and **React**. The project is designed for scalability and ease of use, integrating modern frontend technologies.
## Prerequisites
=======
# Design of Siteware
https://www.figma.com/design/1UcsZsQdZl7XuyA8Q81ccn/Untitled?node-id=0-1&node-type=canvas&t=IStAgQGlXEA06mlC-0
Ensure you have the following installed on your system:
- **Node.js** (v18 or above)
- **npm** or **yarn**
- **Docker**
### Setup
1. Clone the repository:
2. Install dependencies:
```
npm install
```
### Step 3: Run the Development Server
To start the development server and enable hot-reloading for local development, use the following command:
```
npm run dev
```
or for **yarn**:
```
yarn dev
```
The application will be available at:
```
http://localhost:5000
```
### Step 4: Build the Project for Production
To create a production-ready build of the project, run:
```
npm run build
```
or for **yarn**:
```
yarn build
```
This will generate the optimized static files in the `dist` folder.
### Step 5: Preview the Production Build
If you'd like to preview the production build locally, you can use the following command:
```
npm run preview
```
or for **yarn**:
```
yarn preview
```
This will start a server to preview the production build at:
```
http://localhost:5000
```
## Docker Setup
### Step 1: Build the Docker Image
To containerize the project, ensure Docker is installed, and then build the Docker image:
```
docker build -t siteware-frontend .
```
### Step 2: Run the Docker Container
After building the Docker image, run the container using the following command:
```
docker run -p 5000:5000 siteware-frontend
```
The application will be available at:
```
http://localhost:5000
```
## Development Tips
- **Linting**: Ensure code consistency and quality by running the linter:
```
npm run lint
```
- **Testing**: To run tests, use the following command (if tests are configured):
```
npm run test
```
## Accessing the Application in Production
Once deployed, you can access the application on the appropriate server URL.
=======
Now that you're more familiar with your Bitbucket repository, go ahead and add a new file locally. You can [push your change back to Bitbucket with SourceTree](https://confluence.atlassian.com/x/iqyBMg), or you can [add, commit,](https://confluence.atlassian.com/x/8QhODQ) and [push from the command line](https://confluence.atlassian.com/x/NQ0zDQ).