Project structure overview in Remix

Introduction

Knowing the project structure helps you find and organize your files easily. It makes building and maintaining your app simpler.

When starting a new Remix app and you want to understand where to put your code.

When you need to add a new page or feature and want to know the right folder to use.

When debugging or updating your app and you want to quickly locate files.

When collaborating with others so everyone follows the same structure.

When learning Remix to understand how it organizes routes, components, and assets.

Syntax

Remix

my-remix-app/
├── app/
│   ├── routes/
│   ├── components/
│   ├── styles/
│   ├── entry.client.tsx
│   ├── entry.server.tsx
│   └── root.tsx
├── public/
├── remix.config.js
├── package.json
└── tsconfig.json

The app/ folder holds most of your code like pages and components.

The routes/ folder inside app/ maps URLs to files automatically.

Examples

This file creates the homepage at URL /.

Remix

app/routes/index.tsx

Reusable navigation bar component used across pages.

Remix

app/components/NavBar.tsx

Static files like images and icons go here and are served directly.

Remix

public/favicon.ico

Sample Program

This is a simple homepage component inside app/routes/index.tsx. It uses a loader to fetch data and displays a welcome message.

Remix

import type { LoaderFunction } from '@remix-run/node';
import { json } from '@remix-run/node';
import { useLoaderData } from '@remix-run/react';

export const loader: LoaderFunction = async () => {
  return json({ message: 'Welcome to Remix!' });
};

export default function Index() {
  const data = useLoaderData<typeof loader>();
  return (
    <main>
      <h1>{data.message}</h1>
      <p>This is the homepage from <code>app/routes/index.tsx</code>.</p>
    </main>
  );
}

Important Notes

Files inside app/routes/ automatically become pages based on their file name and folder.

Use public/ for images, fonts, and other static assets accessible by URL.

Keep components in app/components/ to reuse UI parts easily.

Summary

Remix projects have a clear folder structure to organize code and assets.

app/routes/ controls your app's pages and URLs.

Understanding this structure helps you build and maintain Remix apps smoothly.

Practice

1. Which folder in a Remix project contains the files that define the app's pages and URLs?

easy

A. app/routes/

B. public/

C. app/components/

D. app/styles/

Solution

1. Step 1: Understand Remix folder roles

   The app/routes/ folder is where you put files that map to pages and URLs in Remix. Since pages and URLs are controlled by route files, app/routes/ is the correct folder.

2. Final Answer:

   app/routes/ -> Option A

3. Quick Check:

   Pages and URLs = app/routes/ [OK]

Hint: Remember: routes folder controls pages and URLs [OK]

Common Mistakes:

• Confusing public folder with routes
• Thinking components folder controls URLs
• Mixing styles folder with routing

2. Which of the following is the correct way to organize static assets like images in a Remix project?

easy

A. Place them inside app/assets/

B. Place them inside public/

C. Place them inside app/routes/

D. Place them inside app/styles/

Solution

1. Step 1: Identify where static files go

   Static assets like images should be accessible directly by the browser, so they go in the public/ folder. The public/ folder is served as-is, making it the right place for images and other static files.

2. Final Answer:

   public/ -> Option B

3. Quick Check:

   Static assets = public folder [OK]

Hint: Static files go in public folder for direct access [OK]

Common Mistakes:

• Putting images inside routes folder
• Confusing assets folder with public
• Placing static files inside styles folder

3. Given this Remix project structure snippet:

app/
  routes/
    index.tsx
    about.tsx
  components/
    Header.tsx
  styles/
    global.css
public/
  logo.png

Which file controls the home page content?

medium

A. app/styles/global.css

B. app/components/Header.tsx

C. public/logo.png

D. app/routes/index.tsx

Solution

1. Step 1: Understand home page routing in Remix

   The home page is controlled by the index.tsx file inside app/routes/. app/routes/index.tsx defines the root URL page, so it controls the home page content.

2. Final Answer:

   app/routes/index.tsx -> Option D

3. Quick Check:

   Home page = routes/index.tsx [OK]

Hint: Home page is always routes/index.tsx [OK]

Common Mistakes:

• Choosing component files for page content
• Confusing public files with pages
• Picking styles files as page controllers

4. You accidentally placed a page file inside app/components/ instead of app/routes/. What will happen when you try to visit that page URL?

medium

A. You will get a 404 Not Found error.

B. The page will load but without styles.

C. The app will crash with a syntax error.

D. The page will load normally as expected.

Solution

1. Step 1: Understand routing folder role

   Only files inside app/routes/ define pages and URLs in Remix. Files in app/components/ are not routes, so the URL won't find the page and returns 404.

2. Final Answer:

   404 Not Found error -> Option A

3. Quick Check:

   Page file outside routes = 404 error [OK]

Hint: Pages must be inside routes folder or get 404 [OK]

Common Mistakes:

• Expecting page to load from components folder
• Thinking app crashes on wrong folder
• Assuming styles affect routing errors

5. You want to add a new page at URL /contact. Which is the correct way to add this page in your Remix project structure?

hard

A. Create app/components/contact.tsx and import it in app/routes/index.tsx.

B. Add contact.html inside public/ folder.

C. Create app/routes/contact.tsx with the page component inside.

D. Create app/styles/contact.css and link it in app/routes/index.tsx.

Solution

1. Step 1: Know how to add new pages in Remix

   New pages are added by creating files inside app/routes/ matching the URL path. For URL /contact, create app/routes/contact.tsx with the page component.

2. Final Answer:

   Create app/routes/contact.tsx with page component -> Option C

3. Quick Check:

   New page URL = new file in routes folder [OK]

Hint: New URL = new file in app/routes folder [OK]

Common Mistakes:

• Adding page files in components folder
• Placing HTML files in public for pages
• Only adding CSS without page component