DEV Community

Cover image for How to create a simple remix app- A beginner guide
Md Enayetur Rahman
Md Enayetur Rahman

Posted on

How to create a simple remix app- A beginner guide

Remix is a framework that allows you to build modern web applications with ease. In this guide, we will walk you through the process of setting up a new Remix project, installing necessary dependencies, and creating a basic application with a simple form.

Introduction

Remix offers a powerful and flexible way to build web applications, leveraging the latest web technologies. It provides a straightforward setup process and integrates seamlessly with Vite, a modern front-end build tool. In this tutorial, you will learn how to create a new Remix project, configure it with Vite, and build a basic form handling example.

Step-by-Step Guide

1. Create a New Remix Project

  • Open the directory where you want to create the project.
  • In the address bar of that folder, type "cmd" and press Enter.
  • A command prompt will appear. Run the following command:
npx create-remix@latest
Enter fullscreen mode Exit fullscreen mode
  • When prompted, provide your project name.
  • Choose not to initialize a new git repository.
  • Choose not to install dependencies with npm.
  • Navigate to your project directory and open it in VS Code:
cd your-project-name
code .
Enter fullscreen mode Exit fullscreen mode

2. Install Dependencies

  • Open the terminal in VS Code and run the following commands:
npm install @remix-run/node @remix-run/react @remix-run/serve isbot@4 react react-dom
npm install -D @remix-run/dev vite
Enter fullscreen mode Exit fullscreen mode

3. Configure Vite

  • Open the vite.config.js file and paste the following code:
import { vitePlugin as remix } from "@remix-run/dev";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [remix()],
});
Enter fullscreen mode Exit fullscreen mode

4. Create the Root Component

  • Open the root.tsx file inside the app folder and paste the following code:
import {
  Links,
  Meta,
  Outlet,
  Scripts,
} from "@remix-run/react";

export default function App() {
  return (
    <html>
      <head>
        <link
          rel="icon"
          href="data:image/x-icon;base64,AA"
        />
        <Meta />
        <Links />
      </head>
      <body>
        <h1>Hello world!</h1>
        <Outlet />
        <Scripts />
      </body>
    </html>
  );
}
Enter fullscreen mode Exit fullscreen mode

5. Create the Index Route

  • Open the _index.tsx file located in the app/routes folder and paste the following code:
import type { MetaFunction } from "@remix-run/node";
import { useState } from "react";

export const meta: MetaFunction = () => {
  return [
    { title: "New Remix App" },
    { name: "description", content: "Welcome to Remix!" },
  ];
};

export default function Index() {
  const [inputValue, setInputValue] = useState('');

  const handleChange = (e) => {
    setInputValue(e.target.value);
  };

  const handleSubmit = (e) => {
    e.preventDefault();
    console.log('Submitted Value:', inputValue);
    setInputValue('');
  };

  return (
    <div>
      <h1>Home Page</h1>
      <form onSubmit={handleSubmit}>
        <label>
          Enter something: 
          <input type="text" value={inputValue} onChange={handleChange} required />
        </label>
        <button type="submit">Submit</button>
      </form>
    </div>
  );
}
Enter fullscreen mode Exit fullscreen mode

6. Build and Serve the Project

  • Open the terminal and run the following commands to build and serve your project:
npx remix vite:build
npx remix-serve build/server/index.js
Enter fullscreen mode Exit fullscreen mode

7. View Your Application

  • Open your browser and navigate to http://localhost:3000. You should see a page with a form where you can enter text and submit it.

Conclusion
By following these steps, you have successfully set up a new Remix project, configured it with Vite, and created a basic form handling example. This setup lays the foundation for building more complex applications with Remix. Continue exploring Remix’s features to enhance your application further.

Top comments (0)