MySvelteUI
Svelte component library in the making
Welcome to MySvelteUI, a Svelte component library designed to streamline the development process. Our library provides a collection of reusable components that are easy to use and integrate into your Svelte projects. Whether you're a beginner or an experienced developer, MySvelteUI offers simplicity and efficiency to enhance your workflow.
Please note that this project is still in development, so expect regular updates and improvements. Documentation is also a work in progress and will be added soon.
Getting Started
For Users
To use MySvelteUI in your project, follow these steps:
- Install the
mysvelte-uipackage from npm:
npm install mysvelte-ui- Import the desired components into your Svelte project's script tag:
import { Button } from 'mysvelte-ui';- Use the imported components in your Svelte template:
<Button>Content</Button>That's it! You can now use MySvelteUI components in your project. Enjoy!
For Developers
If you're a developer and want to contribute to MySvelteUI or fork the repository, follow these steps:
- Clone the repository to your local machine:
git clone https://github.com/Ddupasquier/mysvelte_ui.git- Navigate to the project directory:
cd mysvelte_ui- Install the project dependencies:
npm install- Start the development server:
npm run dev- (Optional) To add a new component, you can use the following command:
npm run newcomp componentnameReplace componentname with the desired name of your new component. This command will scaffold a new component template for you. Please note that the componentname should be in singular form.
The newcomp script fully incorporates the component into MySvelteUI, including adding it to the navigation and making it accessible for import and use in other parts of the library.
That's it! You're now ready to develop and contribute to MySvelteUI. Happy coding!
Documentation
Detailed documentation for MySvelteUI components will be added soon. Stay tuned!