Folder Structure
This page provides an overview of the project structure of a Catalyst app. It covers top-level files and folders, configuration files, and routing conventions.
Top Level Folders
Top-level folders are used to organize your application’s code:
| Folders | Purpose |
|---|---|
config | contains configuration keys for the project (environment variables for server and client) |
src | Source code for application |
client | Entry point for client app |
server | Source code for server (middlewares, controllers, apis etc.) |
build | contains bundled code (this folder is generated after application is built.) |
Configuration Files
Configuration files are used to configure your application, manage routing, assets, state management, and middlewares on the server.
| Files | Purpose |
|---|---|
config/config.json | Contains configuration keys for the project (environment variables for server and client) |
.gitignore | Files to be ignored by git |
src/js/routes/index.js | List of routes |
src/js/store/index.js | Redux Store (optional) |
client/index.js | Entry point for client App |
server/document.js | Document generated from server |
server/index.js | Scripts that run before server is started (if any) |
server/server.js | Middlewares on server |
src/static/css | Global css |
src/static/fonts | Global fonts |