bitsnaps commited on
Commit
582a20f
·
verified ·
1 Parent(s): f088509

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -3
README.md CHANGED
@@ -1,3 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
  # TranStudio
2
 
3
  TranStudio is a web-based application for generating and managing audio transcriptions. It provides an intuitive interface for uploading audio files, generating transcriptions, and managing transcribed content with advanced playback controls.
@@ -32,10 +44,22 @@ TranStudio is a web-based application for generating and managing audio transcri
32
  - SoundFile for audio processing
33
  - Custom waveform visualization
34
 
35
- ## Setup
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
  1. Clone the repository
38
  2. Install dependencies:
39
  ```bash
40
- pip install -r requirements.txt
41
- ```
 
1
+ ---
2
+ title: TranStudio
3
+ colorFrom: indigo
4
+ colorTo: blue
5
+ sdk: docker
6
+ sdk_version: "3.10"
7
+ app_file: main.py
8
+ pinned: false
9
+ fullWidth: true
10
+ header: mini
11
+ ---
12
+
13
  # TranStudio
14
 
15
  TranStudio is a web-based application for generating and managing audio transcriptions. It provides an intuitive interface for uploading audio files, generating transcriptions, and managing transcribed content with advanced playback controls.
 
44
  - SoundFile for audio processing
45
  - Custom waveform visualization
46
 
47
+ ## Hugging Face Spaces Deployment
48
+
49
+ This application is ready to be deployed on Hugging Face Spaces:
50
+
51
+ 1. Create a new Space on Hugging Face with Docker template
52
+ 2. Link this repository to your Space
53
+ 3. Configure the following environment variables in your Space settings:
54
+ - `SECRET_KEY`: A secure random string for JWT encryption
55
+ - `DATABASE_URL`: Database connection string (default: "sqlite:///./transtudio.db")
56
+ - `OPENAI_API_KEY`: Your OpenAI API key
57
+ - `OPENAI_BASE_URL`: OpenAI API base URL (default: "https://api.openai.com/v1")
58
+ - `CORS_ORIGINS`: Comma-separated list of allowed origins
59
+
60
+ ## Local Setup
61
 
62
  1. Clone the repository
63
  2. Install dependencies:
64
  ```bash
65
+ pip install -r requirements.txt