Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/contentmunch/contentmunch-blog

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/contentmunch/contentmunch-blog
Owner: contentmunch
License: mit
Created: 2020-11-16T16:46:03.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-01-02T09:00:30.000Z (about 4 years ago)
Last Synced: 2024-11-17T06:19:18.953Z (about 2 months ago)
Language: TypeScript
Size: 4.89 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![Release publish and deploy](https://github.com/contentmunch/contentmunch-blog/workflows/Release%20publish%20and%20deploy/badge.svg)

# Contentmunch-blog

Front end for contentmunch blog.

## Using Contentmunch-blog 

To use this component library:

* Add the npm package to your project

    ```

    $ npm install @contentmunch/contentmunch-blog

    ```

## Installation guide

In the project directory, you can run:

### `npm start`

Launches the front end on port 3008

### `npm test`

Launches the test runner in the interactive watch mode.


See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the package library.

### `npm run publish`

Publishes the library to npm.

### `npm run deploy`

Deploys the application to production.

## Coding rules

We use [GitHub Flow](https://guides.github.com/introduction/flow/) for our project workflow.

To ensure consistency throughout the source code, keep these rules in mind as you are working:

* Create pull request against develop to merge your code.

* All features or bug fixes **must be tested** by one or more [specs][unit-testing].

### Pull request format

```

* changes 1

* changes 2

fixes/closes #

```

### Git commit format

```

: 

 

 optional

```

* Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.

* The subject contains succinct description of the change:

    * use the imperative, present tense: "change" not "changed" nor "changes"

    * no dot (.) at the end

* Commit type:

    * feat: a new feature

    * fix: a bug fix

    * refactor: a code change that neither fixes a bug nor adds a feature

    * test: adding missing tests

    * chore: changes to the build process or auxiliary tools and libraries such as documentation generation