Kalukator

About

[This project is complete and requires code refactoring.]

Table of Contents About The Project Built With Getting Started Prerequisites Installation Usage Contributing License Contact

There are plenty of Svelte projects out there designed to help people learn a new JavaScript framework, and Kalukator is one of them. The creator wanted to explore something beyond ReactJS, Laravel, and ExpressJS.

Project Highlights:

• Document like website, so it should be easy to navigate all the features
• Basic Svelte implementation such as Effect, Location etc.

This project is essentially a way to get familiar with Svelte, plain and simple. Additionally, it's an opportunity to improve UI/UX using pure TailwindCSS.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/d1azdn/kalukator.git
   

2. Install NPM packages

   npm install
   

3. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes
   

(back to top)

Usage

1. Run the project in your terminal

   npm run dev
   

(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

License

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

(back to top)

Contact

Diaz Saputra - @d1azdn - diazsaputramc@gmail.com

Project Link: https://github.com/d1azdn/kalukator

(back to top)