Skip to main content

For Developers

Babel#

styles#

All styles are in the library-assets/styles folder.

In styles folder we have multiple scss files that imported into main.scss.

After every changes in library-assets/styles, you can run below commands to compile files to css:

  • yarn css: for compile main.scss to css format and will be save in the dist/style.css.

  • yarn css-minify: for compile main.scss to minified css format and will be save in the dist/style.min.css.

  • yarn virgool-css: for compile main.scss to minified and normal css format and will be save in the dist/style.min.css; also if virgool (main project) and virgool-docs (documents project) folder placed next to each other, main.scss will be compiled to css format and save in the virgool/resources/assets/sass/style.min.css.

  • yarn start: all of the above commands plus local server command will be executed.

class#

We can use class names that includes in each file in the library-assets/styles folder.

All class names info documented in docs folder and we can access them from https://virgool-docs.vercel.app/<category-name>/<item-name> url.

React#

files#

All components are in the library folder.

components#

All react components info documented in docs folder and we can access them from https://virgool-docs.vercel.app/<category-name>/<item-name> url.