zach commited on
Commit
0f77dec
Β·
1 Parent(s): 20cccb6

Update project readme

Browse files
Files changed (3) hide show
  1. README.md +19 -2
  2. src/database/crud.py +1 -1
  3. src/static/audio/.gitkeep +0 -0
README.md CHANGED
@@ -30,12 +30,25 @@ Expressive TTS Arena is an open-source web application that enables users to com
30
  ```
31
  Expressive TTS Arena/
32
  β”œβ”€β”€ src/
 
 
 
 
 
 
 
33
  β”‚ β”œβ”€β”€ integrations/
34
  β”‚ β”‚ β”œβ”€β”€ __init__.py # Makes integrations a package; exposes API clients
35
  β”‚ β”‚ β”œβ”€β”€ anthropic_api.py # Anthropic API integration
36
  β”‚ β”‚ β”œβ”€β”€ elevenlabs_api.py # ElevenLabs API integration
37
  β”‚ β”‚ └── hume_api.py # Hume API integration
38
- β”‚ β”œβ”€β”€ __init__.py # Makes src a package; exposes key functionality
 
 
 
 
 
 
39
  β”‚ β”œβ”€β”€ app.py # Entry file
40
  β”‚ β”œβ”€β”€ config.py # Global config and logger setup
41
  β”‚ β”œβ”€β”€ constants.py # Global constants
@@ -45,7 +58,11 @@ Expressive TTS Arena/
45
  β”œβ”€β”€ .env.example
46
  β”œβ”€β”€ .gitignore
47
  β”œβ”€β”€ .pre-commit-config.yaml
48
- └── requirements.txt
 
 
 
 
49
  ```
50
 
51
  ## Installation
 
30
  ```
31
  Expressive TTS Arena/
32
  β”œβ”€β”€ src/
33
+ β”‚ β”œβ”€β”€ assets/
34
+ β”‚ β”‚ β”œβ”€β”€ styles.css # Defines custom css
35
+ β”‚ β”œβ”€β”€ database/
36
+ β”‚ β”‚ β”œβ”€β”€ __init__.py # Makes database a package; exposes methods for persisting votes
37
+ β”‚ β”‚ β”œβ”€β”€ crud.py # Defines operations for interacting with database
38
+ β”‚ β”‚ β”œβ”€β”€ database.py # Sets up SQLAlchemy database connection
39
+ β”‚ β”‚ └── models.py # SQLAlchemy database models
40
  β”‚ β”œβ”€β”€ integrations/
41
  β”‚ β”‚ β”œβ”€β”€ __init__.py # Makes integrations a package; exposes API clients
42
  β”‚ β”‚ β”œβ”€β”€ anthropic_api.py # Anthropic API integration
43
  β”‚ β”‚ β”œβ”€β”€ elevenlabs_api.py # ElevenLabs API integration
44
  β”‚ β”‚ └── hume_api.py # Hume API integration
45
+ β”‚ β”œβ”€β”€ scripts/
46
+ β”‚ β”‚ β”œβ”€β”€ __init__.py # Makes scripts a package
47
+ β”‚ β”‚ β”œβ”€β”€ init_db.py # Script for initializing database
48
+ β”‚ β”‚ β”œβ”€β”€ test_db.py # Script for testing database connection
49
+ β”‚ β”œβ”€β”€ static/
50
+ β”‚ β”‚ β”œβ”€β”€ audio/ # Directory for storing generated audio
51
+ β”‚ β”œβ”€β”€ __init__.py # Makes src a package
52
  β”‚ β”œβ”€β”€ app.py # Entry file
53
  β”‚ β”œβ”€β”€ config.py # Global config and logger setup
54
  β”‚ β”œβ”€β”€ constants.py # Global constants
 
58
  β”œβ”€β”€ .env.example
59
  β”œβ”€β”€ .gitignore
60
  β”œβ”€β”€ .pre-commit-config.yaml
61
+ β”œβ”€β”€ Dockerfile
62
+ β”œβ”€β”€ LICENSE.txt
63
+ β”œβ”€β”€ pyproject.toml
64
+ β”œβ”€β”€ README.md
65
+ β”œβ”€β”€ uv.lock
66
  ```
67
 
68
  ## Installation
src/database/crud.py CHANGED
@@ -1,7 +1,7 @@
1
  """
2
  crud.py
3
 
4
- This module defines the core CRUD operations for the Expressive TTS Arena project's database.
5
  Since vote records are never updated or deleted, only functions to create and read votes are provided.
6
  """
7
 
 
1
  """
2
  crud.py
3
 
4
+ This module defines the operations for the Expressive TTS Arena project's database.
5
  Since vote records are never updated or deleted, only functions to create and read votes are provided.
6
  """
7
 
src/static/audio/.gitkeep ADDED
File without changes