https://github.com/base-cms/base-cms

BaseCMS monorepo
https://github.com/base-cms/base-cms

apollographql cms-framework expressjs graphql hacktoberfest markojs nodejs vuejs

Last synced: 6 days ago
JSON representation

BaseCMS monorepo

• Host: GitHub
• URL: https://github.com/base-cms/base-cms
• Owner: base-cms
• License: mit
• Created: 2018-11-09T13:14:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T06:12:14.000Z (almost 2 years ago)
• Last Synced: 2024-09-26T01:33:34.287Z (9 days ago)
• Topics: apollographql, cms-framework, expressjs, graphql, hacktoberfest, markojs, nodejs, vuejs
• Language: JavaScript
• Homepage: https://support.base-cms.io
• Size: 14.5 MB
• Stars: 6
• Watchers: 2
• Forks: 8
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BaseCMS

[![Build Status](https://img.shields.io/travis/base-cms/base-cms.svg)](https://travis-ci.org/base-cms/base-cms)

[![Docker Pulls](https://img.shields.io/docker/pulls/basecms/base-cms.svg?)](https://hub.docker.com/r/basecms/base-cms/)

[![Image Size](https://img.shields.io/microbadger/image-size/basecms/base-cms/latest.svg)](https://microbadger.com/images/basecms/base-cms)

## Usage

_This repository requires Docker Engine 18.06.0 or greater as Compose file format 3.7 is used._

1. Clone the repository

2. From the project root run `scripts/install.sh` to install dependencies

## Running Services

From the project root, run `scripts/run.sh [SERVICE_NAME]`. For example, to run the dev environment for `graphql-server` run `scripts/run.sh graphql-server`

Available services include:

- `graphql-server`

- `example-website`

- `keyword-analysis`

To bring down all services (and service deps) run `scripts/down.sh`.

## Adding/Removing Dependencies

This repository uses Yarn workspaces for managing packages and services.

- To add dependencies to a workspace run `scripts/workspace.sh [WORKSPACE_NAME] add [package]`

- To remove dependencies from a workspace run `scripts/workspace.sh [WORKSPACE_NAME] remove [package]`

The `WORKSPACE_NAME` is equivalent to the `name` field found in the `package.json` file of the package or service. For example, to add a package to the `graphql-server` service, run `scripts/workspace.sh @base-cms/graphql-server add [package]`

## Yarn

Do _NOT_ run Yarn from your local machine. Instead run Yarn commands using `scripts/yarn.sh [command]`

## Terminal Access

To access the terminal inside Docker run `scripts/terminal.sh`