https://github.com/data-miner00/elm-vite-template

Intuitive, beginner friendly Elm template powered by Vite, supplemented with Tailwind

https://github.com/data-miner00/elm-vite-template

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

elm tailwindcss-v3 template vite
Last synced: 5 months ago · JSON representation

Repository

Intuitive, beginner friendly Elm template powered by Vite, supplemented with Tailwind

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
elm tailwindcss-v3 template vite
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

Contributors Forks Stargazers Issues Apache 2.0 License


Elm Vite Template

Minimalistic Elm Template powered by Vite!
View Demo »

Explore the docs · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

A simple and intuitive Elm template powered by Vite. Built in TailwindCSS and HMR. Focus on the application itself rather than all these low-level configuration stuffs.

Incentives:

  • Could not find intuitive Elm starter templates
  • The Elm development workflow is awkward
  • Want to try out Elmish architecture
  • Buitl this Elm template so I can use for other projects.

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

Built With

The technologies and tools used within this template.

  • Elm
  • Vite
  • TailwindCSS
  • JavaScript

(back to top)

Getting Started

Prerequisites

The list of tools that is used when development.

  • npm sh npm install npm@latest -g
  • Pnpm sh npm i -g pnpm
  • Git
  • Elm

Installation

To use this template for personal use or contribution, simply perform the following.

  1. Clone the repo sh git clone https://github.com/data-miner00/elm-vite-template.git
  2. Install Node dependencies sh pnpm i
  3. Optionally update the dependencies sh pnpm up --latest
  4. Recommend to run tests to check if things are breaking sh pnpm test
  5. Run formatter to format code sh pnpm format
  6. Review Elm code quality sh pnpm review
  7. Start dev server sh pnpm dev
  8. Compile for production sh pnpm build
  9. Preview production build sh pnpm preview
  10. Start standalone Elm reactor sh pnpm elm:dev
  11. Build standalone Elm code sh pnpm elm:build
  12. Start interactive Elm shell sh pnpm repl

(back to top)

Roadmap

  • [x] Add Homepage
  • [ ] Add 404 page
  • [ ] Dark mode
  • [ ] Add GitHub workflows
  • [ ] Add PWA Manifest
  • [ ] Mobile Responsive
    • [ ] Navbar and header
  • [ ] Add E2E tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

(back to top)

Owner

  • Name: Shaun Chong
  • Login: data-miner00
  • Kind: user
  • Location: undefined, Mars
  • Company: Experian

Full Queue Developer

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 21
  • Total Committers: 1
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
data-miner00 d****0 21

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels