An Boilerplate to work with Elm

Features and tools:

• Build
  • Vite
  • EsBuild
  • Elm-Spa
  • Docker
• Code
  • Elm
  • JavaScript
  • TypeScript
• Style
  • Sass
  • PostCss ++ Plugins
  • Open-Props
  • Tailwind
• Formatting
  • EditorConfig

Run the project

If you want to see the demo before, start coding: Demo - Revex

Dependencies

This project requires Node.js version 16.14.2 - LTS or above.
And I recommend the use of yarn.

Installation

To start, you have two options:

1. Make a fork from this repository. not recommended
2. Press the Use this template button and follow the GitHub instructions. recommended

Then, on the project folder/directory, run the command to install all the dependencies.

yarn install

You can use npm if you prefer

Run Locally

Because of Vite, when all the dependencies are installed, it's super simple to start a local server.

Development.

This should make a local server on the port 3000.

yarn dev

With the code running, go to: http://localhost:3000

Production.

This command will generate a production version of your code.

yarn build

And to check production locally. (need to run build first)

yarn preview

How to deploy your code to show to the world what can you do.

This project has a Netlify base settings. You can see this on the netlify.toml file.

So if you want to follow this path of deploying it. It is super easy and simple. Just go to Netlify website, make an account or login in. Add your repository with this template and follow the instructions of Netlify.

<- When you get to this point:
    Don't change anything if you don't know what are you doing.

If you see this logs, your site is up for everyone to see ✨