Skip to content

Home

Jump to bottom
MaelVB edited this page May 31, 2022 · 8 revisions

AquilaCMS

License Badge Codacy Badge Build Status

AquilaCMS

AquilaCMS is an Open Source ecommerce web application, 100% javascript with MERN Stack. Front-end can be used with ReactJS and NextJS (for Server Side Rendering) or any other JS technology (VueJS, Angular, etc). A complete Back office is available for managing your website. You can download some modules or themes in Aquila's Shop.

AquilaCMS

Server configuration

To install the latest AquilaCMS, you need a web server running :

  • node.js 12.19.0+
  • mongoDB 4.2.5+

The package manager yarn 1.22.4+ is required.

System packages

  • You must verify that you have these packages installed on your OS :
g++ gcc libgcc libstdc++ linux-headers make python libtool automake autoconf nasm wkhtmltopdf vips vips-dev libjpeg-turbo libjpeg-turbo-dev

Installation

You can download the source code from GitHub and run the following command-line (not 'Windows cmd') to launch the installer.

  • With npm :
yarn install
npm start
  • With pm2 :
yarn install
cp ecosystem.config.example.js ecosystem.config.js
npm run start:pm2
  • With docker :
docker pull aquilacms/aquilacms
docker run -p 127.0.0.1:3010:3010/tcp aquilacms/aquilacms

At the first launch, there is an installation page. It allows you to create an env.json file in the config folder.

You can edit this file manually, an example of the different possible properties is in the config/env.example.json file. You can also found all the properties in the documentation

⚠️Warning : there is not MongoDB in AquilaCMS image

To connect your AquilaCMS website to a Mongo database, you can :

  • run a MongoDB image next to the AquilaCMS image
  • use an external link to, for example, an Atlas database
  • use a localhost link to connect AquilaCMS to a database on your host machine (you have to edit your mongod.conf and change your bindIp by your network ip instead of 127.0.0.1)

Have the installation page again

If you want to have the installation page again, you can remove the env.json file in the config/ folder.

Manually build the theme

If you want, for any reason, to manually build a theme, you can execute this command at the root of AquilaCMS :

npm run build:win --theme=default_theme
  • Instead of build:win you can use build:linux
  • At the variable --theme you need to put the name of the theme folder you want to build.

Documentations

Find some documentation on https://doc.aquila-cms.com/

For the API, the swagger documentation is online at aquila-cms.com/api-docs or local (/api-docs)

Also check-out some tutorials on :

Contribute

If you want to contribute, you will need to install husky or else you won't be able to commit new features

yarn husky:install

License

AquilaCMS is licensed under OSL3

Aquila

Clone this wiki locally