Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor back-end code #187

Open
5 of 6 tasks
StephanAkkerman opened this issue Dec 30, 2024 · 2 comments · May be fixed by #195
Open
5 of 6 tasks

Refactor back-end code #187

StephanAkkerman opened this issue Dec 30, 2024 · 2 comments · May be fixed by #195
Assignees
Labels
Difficulty: Medium 😐 This issue can be solved, but a decent amount of lines need to be changed Improvement 📈 Improvement In Progress 🚧 This issue is currently actively being worked on Overhaul 🌈 Overhaul a part of the code Priority: Low 🥉 Assign this label if this issue is used once every few days

Comments

@StephanAkkerman
Copy link
Owner

StephanAkkerman commented Dec 30, 2024

  1. Description:

    • Problem:
      The backend code is a bit of a mess right now. We are also misusing the pip install functionality right now to make it a package. The folder structure should be looked at and maybe some python files can be merged or moved.

    • Solution:
      Look into the file structure, the consequences of not using a pip package for the installation, renaming the directories and files, and more?

    • Prerequisites:
      [List any requirements or dependencies needed before starting.]

  2. Tasks:

    • Remove pip installation
    • Redo file structure
    • Rename files
    • Group code
    • Rerun tests
    • Test all code
  3. Additional context
    On request of @TimKoornstra

@StephanAkkerman StephanAkkerman added Difficulty: Hard 😭 This issue is hard to solve, a lot of code needs to be changed Improvement 📈 Improvement Overhaul 🌈 Overhaul a part of the code labels Dec 30, 2024
@StephanAkkerman StephanAkkerman self-assigned this Dec 30, 2024
@StephanAkkerman StephanAkkerman added the Priority: Low 🥉 Assign this label if this issue is used once every few days label Dec 30, 2024
@StephanAkkerman
Copy link
Owner Author

StephanAkkerman commented Jan 2, 2025

@TimKoornstra Should we ask uithub or repo2txt for suggestions on file structure?

@TimKoornstra
Copy link
Collaborator

TimKoornstra commented Jan 2, 2025

Something more like this for the file structure:

.
├── backend/
│   ├── requirements.txt       # Python dependencies
│   │
│   ├── fluentai/              # Your main application code
│   │   ├── __init__.py
│   │   ├── logger.py          # Logging setup
│   │   ├── api/
│   │   │   ├── __init__.py
│   │   │   ├── app.py         # FastAPI entry point
│   │   │   └── routes.py      # API routes
│   │   ├── constants/
│   │   │   ├── __init__.py
│   │   │   ├── config.py
│   │   │   └── languages.py
│   │   ├── services/
│   │   │   ├── imagine/
│   │   │   │   ├── __init__.py
│   │   │   │   ├── image_gen.py
│   │   │   │   └── verbal_cue_gen.py
│   │   │   ├── mnemonic/
│   │   │   │   ├── ...
│   │   │   ├── tts/
│   │   │   │   ├── fallback.py
│   │   │   │   └── tts.py
│   │   │   └── ...
│   │   ├── utils/
│   │   │   ├── __init__.py
│   │   │   ├── fasttext.py
│   │   │   └── model_loader.py
│   │   └── data/
│   │       ├── g2p-to-tss-mapping.parquet
│   │       ├── languages.json
│   │       ├── config.yaml
│   │       └── tts-languages.parquet
│   │
│   └── tests/                  # Root-level tests directory
│       ├── __init__.py
│       ├── test_api/           # Test FastAPI endpoints
│       │   ├── __init__.py
│       │   ├── test_routes.py
│       ├── test_services/      # Test backend services
│       │   ├── __init__.py
│       │   ├── test_imagine.py
│       │   ├── test_tts.py
│       │   └── ...
│       └── test_utils.py       # Test general utilities
├── frontend
│   └── ...               # Your Next.js application
├── .github
│   └── ...               # GitHub Actions, Issue templates
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md

@github-actions github-actions bot added the In Progress 🚧 This issue is currently actively being worked on label Jan 4, 2025
@StephanAkkerman StephanAkkerman linked a pull request Jan 4, 2025 that will close this issue
14 tasks
@StephanAkkerman StephanAkkerman added Difficulty: Medium 😐 This issue can be solved, but a decent amount of lines need to be changed and removed Difficulty: Hard 😭 This issue is hard to solve, a lot of code needs to be changed labels Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: Medium 😐 This issue can be solved, but a decent amount of lines need to be changed Improvement 📈 Improvement In Progress 🚧 This issue is currently actively being worked on Overhaul 🌈 Overhaul a part of the code Priority: Low 🥉 Assign this label if this issue is used once every few days
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants