Project Structure | Remix Firebase SaaS Kit
A quick overview of the project structure and how to navigate it in Remix Firebase SaaS Kit.
When inspecting the project structure, you will find something similar to the below:
tasks-appāāā README.mdāāā @typesāāā srcā āāā componentsā āāā coreā āāā libā āāā routes āāā __app āāā __site āāā auth āāā invite āāā onboardingā āāā root.tsxāāā package-lock.jsonāāā package.jsonāāā publicā āāā favicon.icoāāā tsconfig.jsonNB: we omitted a lot of the files for simplicity.
Let's take a deeper look at the structure we see above:
src/core: this folder contains reusable building blocks of the template that are not related to any domain. This includes components, React hooks, functions, and so on.src/components: this folder contains the application's components, including those that belong to your application's domain. For example, we can add thetaskscomponents tosrc/components/tasks.src/lib: this folder contains the business logic of your application's domain. For example, we can add thetaskshooks to write and fetch data from Firestore insrc/lib/tasks.src/routed: this is Remix folder where we add our application routes.
Don't worry if this isn't clear yet! We'll explain where we place our files in the sections ahead.