Skip to content

gaia-react/remix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to GAIA React!

GAIA

GAIA React is a fully comprehensive template for building modern React web applications.

It is designed to be the best possible starting point for any professional React project.

It comes with EVERYTHING you need, fully configured and ready to go.

The Developer Experience (DX) is designed to be top-notch.

  • Automated and robust code quality tools are all set up, keeping your code clean and tech debt to a minimum.
  • Best practices are baked into the source code examples for you to follow.
  • Utilities, hooks, authentication, components, services, styles, tests, stories, and other code examples are all included to help you get started quickly.
  • Unit, integration, visual regression, and end-to-end tests are set up.
  • While GAIA comes with recommended packages, conventions, and settings, you're free to change or remove them to suit your needs!

GAIA React has many great features built-in:

No matter what your skill level or experience, GAIA will make your life and your code better.

Read the GAIA Documentation for detailed information about working with GAIA.

Is this associated with the GAIA Flash Framework?

Yes!

The GAIA Flash Framework revolutionized Flash website development and became the most popular Flash framework in the world (second only to Adobe Flex, which was focused on enterprise applications). It was used to build over 100,000 Flash sites and relied upon by every major digital agency worldwide.

GAIA React is its spiritual successor. It has been reborn as a React template. Like its predecessor, it's designed to be the most comprehensive and easy-to-use React template available, to build professional-grade frontend applications.

Installation

Make sure you have Node.js >=20.17.0 LTS installed, preferably via nvm.

All you need to do is run this installation command and get to work.

npx create-remix@latest --template gaia-react/remix

When prompted, to install packages and run the remix.init, select "Yes".

If you choose "No", you will need to run these two commands manually after the installation:

npm install

npx remix init

Development

Here's how to develop with GAIA.

Storybook

npm run storybook

Remix

npm run dev

Styling

This template comes with Tailwind CSS configured, with some configuration and utilities, which you can change to suit your project.

See the Vite docs on css for more information.

Icons

FontAwesome is included. You're free to change it if you like.

i18n

Remix-i18next is configured with examples.

Storybook is already configured with react-i18n support.

Testing

GAIA comes with a full testing suite already configured.

Unit and Integration

  npm t
  // or
  npm run test

Visual Regression

Chromatic

You'll need to set your CHROMATIC_PROJECT_TOKEN env variable on your CI.

E2E

PlayWright

npx playwright test

Interactive mode:

npx playwright test --ui

Deployment

GAIA comes with the default Remix deployment configuration. You can change this to whatever deployment process you prefer.

Here's the basic Remix deployment process:

npm run build

Then run the app in production mode:

npm start

You'll need to pick a host to deploy it to. Jacob Paris wrote a great article on where to host your Remix app.

DIY

If you're familiar with deploying Node applications, the built-in Remix app server is production-ready.

Make sure to deploy the output of npm run build

  • build/server
  • build/client