Skip to content

Project Structure

StartKit.AI uses a basic project structure that makes it simple to add your own code or edit ours.

  • /server/ - The API and associated backend code (node + Koa)
  • /src/ - The frontend-application code, demos and Admin Dashbaord (React + Vite)

Default structure

  • Directoryserver/
    • Directoryroutes/ # REST API routes
    • Directoryservices/ # Services consumed by the API routes
    • Directorydb/ # database model definitions and db functions
      • Directorymodels/
      • Directorytypes/
      • users.js
    • Directoryai-providers/
      • openai.js # the openai client
    • Directoryhelpers/ # helper functions
    • Directoryjobs/ # scheduled tasks
    • api.js
    • index.js
  • Directorysrc
    • Directoryadmin/ # The frontend code for the Admin Dashboard
    • Directorydemos/ # The frontend code for the Demos
    • Directorypublic/ # Any public assets, eg images, fonts
      • favicon.png
      • images
    • index.jsx
    • index.html
  • package.json

Standalone server

If you just want to run StartKit.AI as a standalone API server (without the optional Admin Dashboard or demos) then it’s safe to delete the /src directory.