https://github.com/bcms/backend
https://github.com/bcms/backend
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bcms/backend
- Owner: bcms
- License: mit
- Created: 2020-07-26T08:37:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T09:14:14.000Z (almost 2 years ago)
- Last Synced: 2025-06-25T23:09:48.227Z (about 1 year ago)
- Language: TypeScript
- Size: 22.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BCMS Backend
This is a repository for the BCMS Backend project which is a core module of the [BCMS](https://github.com/becomesco/cms) . It provides a REST API for the [BCMS UI](https://github.com/becomesco/cms-ui) and third party applications (like websites and dashboards). This API is currently accessible in 3 ways:
- Using [BCMS SDK](https://github.com/becomesco/cms-sdk/tree/next) - 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](https://github.com/becomesco/cms-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](https://rest-apis.thebcms.com/bcms-backend/3-0-0).
## For Developers
BCMS Backend is written using [Purple Cheetah](https://github.com/becomesco/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](https://github.com/becomesco/cms-shim) and it must be run in conjunction with the backend. Before you get started developing, you will need to install:
- [Docker](https://www.docker.com/),
- [Docker Compose](https://docs.docker.com/compose/),
- [NodeJS 14+](https://nodejs.org/) and
- [NPM](https://www.npmjs.com/)
You can use [YARN](https://yarnpkg.com/) but NPM is recommended.
### Get started
- 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.