Quick start

This project comes in two versions: one using Vite and another using Next.js, giving you flexibility depending on your preferred development setup. Before using Mira, make sure Node.js is installed. You can find the required Node.js version in the .nvmrc file located in the project root.

Once Node.js is installed, run npm install to install the rest of Mira's dependencies. All dependencies will be downloaded to the node_modules directory.

npm install

Now you're ready to modify the source files and generate new dist/ files. Mira is using Vite to automatically detect file changes and start a local webserver at http://localhost:3000.

npm start

Build tools

Start a local webserver at http://localhost:3000 and detect file changes:

npm start

Compile, optimize, minify and uglify all source files to dist/:

npm run build

Contents

Inside the zip-file you'll find the following directories and files. Both compiled and minified distrubution files, as well as the source files are included in the package.

theme/
  ├── .env
  ├── .eslintrc
  ├── .gitignore
  ├── .prettierrc
  ├── package.json
  ├── package-lock.json
  ├── vite.config.js
  ├── README.md
  ├── index.html
  ├── dist/
  ├── public/
  │   ├── index.html
  │   └── manifest.json
  └── src/
      ├── components/
      ├── contexts/
      ├── hooks/
      ├── layouts/
      ├── mocks/
      ├── pages/
      ├── redux/
      ├── theme/
      ├── utils/
      ├── vendor/
      ├── App.jsx
      ├── config.js
      ├── constants.js
      ├── i18n.js
      ├── index.jsx
      └── routes.jsx