index.yml

# Alphabetically Ordered Please!!
# NOTE: create-scaffoldly-app pulls from this list
#       - .templates/csa/README.md.tpl uses these values as well
"Frameworks":
  # ".NET":
  #   "C#":
  #     branch: dotnet-csharp
  #     projectFile: DotNetCSharpApp.csproj
  #     type: dotnet
  "Go":
    "ConnectRPC":
      readmeName: "ConnectRPC"
      branch: go-connect
      projectFile: go.mod
      configFile: scaffoldly.json
      type: go
      rm: ["go.sum"]
      handler: "localhost:8080"
      main: cmd/server/main.go
      devCommand: "go run cmd/server/main.go"
    "HTTP":
      readmeName: "Go HTTP"
      branch: go-http
      projectFile: go.mod
      configFile: scaffoldly.json
      type: go
      rm: ["go.sum"]
      handler: "localhost:8080"
      main: cmd/server/main.go
      devCommand: "go run cmd/server/main.go"
  "Node":
    "ConnectRPC (with Fastify)":
      readmeName: "ConnectRPC"
      branch: node-connect
      projectFile: package.json
      type: node
      rm: ["package-lock.json"]
      handler: "localhost:8080"
      main: server.ts
      devCommand: tsx server.ts
    "ExpressJS":
      readmeName: "ExpressJS"
      branch: node-express
      projectFile: package.json
      type: node
      rm: ["package-lock.json"]
      handler: "localhost:3000"
      main: routes/index.js
      devCommand: "DEBUG=* npm start"
    "Next.js":
      readmeName: "Next.js"
      branch: node-nextjs
      projectFile: package.json
      type: node
      rm: ["package-lock.json"]
      handler: "localhost:3000"
      main: src/app/page.tsx
      devCommand: "npm run dev"
    "Next.js (in Export mode)":
      readmeName: "Next.js"
      branch: node-nextjs-export
      projectFile: package.json
      type: node
      rm: ["package-lock.json"]
      handler: "localhost:3000"
      main: src/app/page.tsx
      devCommand: "npm run dev"
    "Next.js (in Standalone mode)":
      readmeName: "Next.js"
      branch: node-nextjs-standalone
      projectFile: package.json
      type: node
      rm: ["package-lock.json"]
      handler: "localhost:3000"
      main: src/app/page.tsx
      devCommand: "npm run dev"
    "React (with Vite)":
      readmeName: "React"
      branch: node-react-vite
      projectFile: package.json
      type: node
      rm: ["package-lock.json"]
      handler: "localhost:3000"
      main: src/App.tsx
      devCommand: "npm run dev"
  Ollama:
    "Server":
      readmeName: "Ollama"
      branch: ollama
      configFile: scaffoldly.json
      projectFile: scaffoldly.json
      type: standalone
      rm: []
      handler: "localhost:11434"
      main: scaffoldly.json
      setupCommands:
        - ollama serve
        - ollama pull llama3.2:1b
      devCommand: 'curl http://localhost:11434/api/generate -d ''{"model": "llama3.2:1b","prompt":"Why is the sky blue?"}'''
  Python:
    "Flask":
      readmeName: "Flask"
      branch: python-flask
      configFile: scaffoldly.json
      projectFile: scaffoldly.json
      type: standalone
      rm: []
      handler: "localhost:8000"
      main: app.py
      setupCommands:
        - python -m venv .venv
        - source .venv/bin/activate
        - pip install -r requirements.txt
      devCommand: "gunicorn app:app --reload"
    "Flask (with Poetry)":
      readmeName: "Flask"
      branch: python-flask-poetry
      projectFile: pyproject.toml
      type: python
      rm: ["poetry.lock"]
      handler: "localhost:5000"
      main: server/__init__.py
      devCommand: "poetry run flask run"
    "Hugging Face (w/Flask)":
      readmeName: "Hugging Face (w/Flask)"
      branch: python-huggingface
      configFile: scaffoldly.json
      projectFile: scaffoldly.json
      type: standalone
      rm: []
      handler: "localhost:8000"
      main: app.py
      setupCommands:
        - python -m venv .venv
        - source .venv/bin/activate
        - pip install -r requirements.txt
      devCommand: "gunicorn app:app --reload"
  Rust:
    "Axum":
      readmeName: "Rust"
      branch: rust-axum
      projectFile: Cargo.toml
      configFile: Cargo.toml
      type: rust
      rm: ["Cargo.lock"]
      handler: "localhost:3000"
      main: src/main.rs
      devCommand: "cargo run"
    "Hyper":
      readmeName: "Rust"
      branch: rust-hyper
      projectFile: Cargo.toml
      configFile: Cargo.toml
      type: rust
      rm: ["Cargo.lock"]
      handler: "localhost:3000"
      main: src/main.rs
      devCommand: "cargo run"