fatjonfreskina / borealis-template

MIT License
0 stars 0 forks source link

Borealis template by Fatjon Freskina :snowflake:

Netlify Status

The idea is to create a simple, responsive and easy to customize template for small businesses, startups or personal projects. The template is built with Vue3 using the options API and Bootstrap5. The goal is to keep it simple and easy to customize, so you can focus on the content and not on the code.

Demo can be found here :link:

Features :sparkles:

ROADMAP :construction:

Check the issues for the roadmap and the features that are going to be implemented. Feel free to contribute to the project. :raised_hands:

Installation :wrench:

npm install

Run :running:

npm run dev

Deploy :rocket:

npm run build already creates a _redicts file for netlify, so you can deploy it there.

Contribute :raised_hands:

Contributions are more than welcome using the "fork and pull request" workflow. Briefly:

  1. Fork the project and clone it locally.
  2. Create a new branch following the pattern <placeholder>-issueNumber. Where placeholders can be develop, bugfix, documentation only.
  3. Make your changes and push them to your fork.
  4. Create a pull request to the main branch.
  5. Your pull request will be reviewed and merged.

License :page_facing_up:

Distributed under the MIT License. See LICENSE for more information.