Download Narvuk TWUI

To get started, download by pulling and cloning directly from the GitHub repo.

https:// clone link

Follow these steps before changing any files

1. Install Node.js
2. Install Ruby + DevKit
3. Run npm run setup - This will setup dependancies for node and ruby
4. Run npm run dev - This will start the development web server
5. Run npm run watch - This will run tailwindcss cli to monitor changes to css in html
6. Open your browser and go to http://localhost:4000

Note* If tailwindcss cli stops running or css changes are not seen just re run the cli by running command npm run watch

Simply download and extract the template files to your local machine.

Add the provided stylesheets and JavaScript files to your project, and you're good to go!

Explore the documentations or html files to see all available components and how to customize them to fit your needs.

Optimisations

On Production use narvuktwui.min.css and app.min.js as these are minified versions

When contributing to or fixing issues in this repository, please follow the steps below to ensure your changes are implemented consistently and correctly. We monitor pull requests (PRs) to merge changes into the main branch.

Follow these steps:

1. Fork the repository
2. Make your changes in a new branch (ensure to follow our code style)
3. Test your changes locally to ensure everything works
4. Create a pull request from your forked repository
5. Wait for approval and discuss your changes if necessary

We appreciate all contributions and will review them as soon as possible. Please be patient as we may take time to test and review your changes.

If you encounter any issues or need assistance with the template, feel free to open an issue on our GitHub repository. Please provide as much detail as possible (e.g., error messages, steps to reproduce, screenshots) to help us resolve the issue efficiently.

We strive to respond and fix issues as quickly as possible. Your feedback is crucial to improving this project!