@paroicms/server/README.md

The ParoiCMS server

# @paroicms/server

This is the main package of ParoiCMS. **ParoiCMS** is a full-featured CMS for building showcase websites. It includes: **custom content**, a robust **cache system**, a **plugin** architecture, **multilingual** websites (currently in English, French, German, Spanish, Italian, Portuguese), and it is **multi-sites**.

Documentation: [www.paroicms.org](https://www.paroicms.org/) (still working on it).

## Try it

Generate your own website structure using the [Site Generator](https://generator.paroicms.org/). From your website admin, download a backup: it's a full Node.js project ready to be installed and executed locally.

## Tips

Here are some tips:

- In the admin, start with _Configuration → Site properties_;
- Read the `config.json` file for the configuration;
- Read the `site-schema.json` file: the custom content of your website is defined here;
- The file `theme/theme.json` contains the list of available sizes (in pixels) in the text editors;
- You'll find the SCSS in `theme/assets/scss/`;
- If you edit your theme with Visual Studio Code, then we suggest that you install the _Shopify Liquid_ extension from _Shopify.com_;
- HTML templates of your website are in `theme/templates/`;
- In a LiquidJS file (for example `theme/templates/home.liquid`), use our `info` filter to inspect the content of any payload:

```liquid
{{ site | info }}
{{ doc | info }}
```

## Technologies

Themes for ParoiCMS are written in [LiquidJS](https://liquidjs.com/) (the syntax from Shopify). Data is stored in SQLite databases.

## Contributing

Please start with the [instructions in our monorepo](https://gitlab.com/paroi/opensource/paroicms#contributing).

## License

Released under the [MIT license](https://gitlab.com/paroi/opensource/paroicms/-/blob/main/LICENSE.md).