@paroicms/server
TypeScript icon, indicating that this package has built-in type declarations

1.28.3 • Public • Published

@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 and French)
  • Multi-sites

Themes for ParoiCMS are written in LiquidJS (the syntax from Shopify). Data is stored in SQLite databases.

While it's a new solution, we can ensure that ParoiCMS is already robust. It is currently used in production by us and our clients.

How to generate a new website

Run the following commands:

npx @paroicms/cli --create mywebsite --language en
cd mywebsite
npm i
npm run dev

Then, connect to your back-office: http://localhost:8080/adm. Use dev@localhost for the login, and init for the password.

Tips

Here are some tips:

  • In the back-office, starts with Configuration → Site properties;
  • Read the config.json file: it is the configuration (by default for a local environment);
  • 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/index.scss, it is compiled by the watcher in theme/assets/scss/index.css;
  • If you edit your theme with Visual Studio Code, then we suggest that you install the Liquid extension, from panoply (liquify.dev);
  • 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:
{{ site | info }}
{{ doc | info }}

Documentation

Contribute

Please start with the instructions in our monorepo.

License

Released under the MIT license.

Package Sidebar

Install

npm i @paroicms/server

Weekly Downloads

463

Version

1.28.3

License

MIT

Unpacked Size

1.19 MB

Total Files

627

Last publish

Collaborators

  • rickfaf
  • paleo