Backend for the BCMS
This is a repository for the BCMS Backend project which is a core module of the BCMS . It provides a REST API for the BCMS UI and third party applications (like websites and dashboards). This API is currently accessible in 3 ways:
- Using BCMS SDK - It provides a lot of features in addition to automated security and Abstracted REST API calls. Some of them are client side caching, error handling, type system and many more.
- Using BCMS Client - Is subset of BCMS SDK features more oriented for use in websites, in secure or not secure environment.
- Using HTTP requests (REST API) - List of endpoints can be seen in BCMS API docs.
BCMS Backend is written using Purple Cheetah tool set and if you are not familiar with it, it would be a good idea to check it out. This project depends on the BCMS Shim and it must be run in conjunction with the backend. Before you get started developing, you will need to install:
- Docker,
- Docker Compose,
- NodeJS 14+ and
- NPM
You can use YARN but NPM is recommended.
- Clone the repository: git clone git@github.com:becomesco/cms-backend,
- Install dependencies: npm i,
- Full - docker-compose up
- Standalone development - BCMS Shim and Proxy will not be started - docker-compose -f compose-standalone.yml up (have in mind that you will need Shim running in a separate container)
- Done, once you change something in the ./src application will be reloaded. Make sure to use docker-compose build if needed.