Project structure
This section explains the purpose of each file and folder in your project. Here's the breakdown:
-
app/
The main directory where your Kottster app lives. It contains all the files and folders needed to run your app.
-
index.html
The HTML template for your app. It defines the structure of the HTML document, including the
<head>
and<body>
sections. -
main.jsx
The root component of your React application. It initializes the app and renders the main component tree.
-
pages/
Contains all your app's pages. Each folder corresponds to a page in the app. The folder name is used as the URL path.
Each page consists of two files:
index.jsx
- Contains the frontend React componentapi.server.js
- Contains the backend controller logic
Example structure:
pages/
├── users/
│ ├── index.jsx
│ ├── api.server.js
│ └── settings.json
└── dashboard/
├── index.jsx
└── api.server.js -
_server/
Contains server-side files.
-
app.js
The file with app initialization logic. It creates a new Kottster app instance and sets up data sources.
-
server.js
The file that imports the app instance and starts the server.
-
data-sources/
Contains data source files. Learn more
-
-
public/
The optional directory where you store static assets like images, fonts, and other files.
-
-
kottster-app.json
A JSON file that contains the Kottster app schema including the app's metadata and navigation structure.
-
vite.config.js
The configuration file for Vite build tool. It defines how your app is built and served, including plugins and optimizations.
-
package.json
Specifies the packages your app needs to run and how to build or start it.
-
tsconfig.json
Specifies TypeScript configuration options, such as type-checking rules, paths, and compiler settings. You only need this file if you're using TypeScript.