Setup
How to install Webcore
Report Issue ↗️Webcore can be used as a standalone project, or it can be integrated into your existing Astro, Svelte, or React ecosystems. The easiest way to get started is to run the following command in your terminal, and follow the prompts:
You can also clone the repository and run npm run dev
to start building your pages with the components available.
Manual Install
If you’re looking for specific instructions on how to integrate Webcore into your techstack, we recommend reading through our integration guides:
Webcore components use Sass for styling and TypeScript for type safety. To use the component library, make sure you have the following packages installed:
- Sass -
v1.77
and above - TypeScript -
v5.4
and above
You can use the following command in your terminal to installed the above packages if you don’t have them already:
The library can be used with Astro, Svelte, and React. Depending on your project setup, you’ll also need the following packages:
-
Installation
Install Webcore as a dependency by running the following command:
-
Setup Configurations
Add an empty
webcore.config.scss
file at the root of your project. You can read more about how you can configure your CSS using this file in the CSS Configuration section.Setup default styles and fonts by calling the following in your global SCSS file:
You can download the fonts Webcore uses from thepublic/fonts
directory.You’ll also need to update your Astro configuration file at the root of your project directory with the following lines:
-
Using Components
That’s it! You’re all set to start using Webcore components in your Astro project:
Request improvement for this page