# Installation

Materio is built using Create Next App (opens new window). Create Next App sets up everything automatically for you.

# Guide

First of all make sure you have installed Node (opens new window) and npm (opens new window) / yarn (opens new window)

TIP

Yarn package manager is recommended

Requirements

Please make sure you use the node’s LTS version which is recommended by the official node site and not the one with the latest features or previous versions. Our project is not tested to work with other Node versions.

Important!

Before installing the node_modules, make sure you have files starting with a dot(.eslintrc, .env etc..). It mostly happens when hidden files are not enabled on your machine and you try to copy our template at some other place on your system.

  • After downloading zip, copy this zip to your desired location and then unzip it. Do not unzip first and then copy files to another location, it may not be able to run the template due to missing hidden files not copied over.

  • In the uncompressed folder, you will find the typescript-version and javascript-version folders which contains the full-version & starter-kit folders. Open the one you want to get started with in your code editor.

  • Run below command in console:

  • After installing the modules run your project with following command:
  • You will find following output after running above command in console:
console-output-of-development-server

NOTE

Your network URL might not have same URL as screenshot and that is completely fine. It depends on your network.

Last Updated: 6/22/2023, 7:07:20 AM