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 all backend code (node + Koa)
• /web/ - Example code for building a frontend application, plus the Admin Dashbaord (React + Vite)

Default structure

• Directoryserver/

  • Directoryapi/ # the modules for performing AI tasks

    • Directorymodules/

      • Directorychat/

        • routes.js # each module has a routes file
        • … # and several other files
      • Directorydetect/

        • …
      • Directoryembeddings/

        • …
      • Directoryimages/

        • …
      • Directorymoderation/

        • …
      • Directoryspeech/

        • …
      • Directorytext/

        • …
  • Directorydatabase/ # database model definitions and functions

    • Directorymodels/

      • …
    • Directorytypes/

      • …
    • users.js
  • Directorydocs/ # where the API reference is served from

    • …
  • Directoryhelpers/ # helper functions

    • …
  • Directoryjobs/ # where scheduled tasks live

    • …
  • index.js
• Directoryweb # frontend code

  • Directoryadmin/ # The frontend code for the Admin Dashboard

    • …
  • Directorydemos/ # The frontend code for the Demos

    • …
  • Directorypublic/ # Any public assets, eg images, fonts

    • …
  • 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 /web directory.