Welcome to Stencil, stencil starter designed for seamless integration across various platforms including Stencil, Angular, and Vue. This document will guide you through the process of starting and optionally renaming the library, updating the repository origin, and setting up the development environment.
Before you begin, ensure you have Node.js and npm installed on your system. You can download and install them from Node.js official website.
Follow these steps to set up your project:
-
Clone the repository:
git clone https://github.com/username/my-library.git cd my-library -
Install dependencies:
npm install
To rename the library from the default 'my-library' to your preferred name:
-
Run the rename command from the root directory:
npx gulp default --name <new-library-name>
Replace
<new-library-name>with the name you want to assign to the library. -
(Optional) To update the remote repository origin:
npx gulp default --name <new-library-name> --origin <username/repo-path>
Replace
<username/repo-path>with your GitHub username and repository path.
If you renamed the library to foo-library, the core Stencil library will be named foo-library and the framework-specific libraries will be suffixed accordingly:
- Angular:
foo-library-angular - Vue:
foo-library-vue
After renaming, the gulp task will automatically start watching the files for changes. You can continue developing and testing your changes across all integrated frameworks.
Contributions are welcome! Please read our contributing guidelines in CONTRIBUTING.md to learn about our submission process, coding standards, and more.
This project is licensed under the MIT License - see the LICENSE file for details.
This README is designed to provide a quick and straightforward overview of setting up and customizing the project. Adjustments might be necessary to fit additional details specific to your project's needs or organizational guidelines.