https://github.com/kontrollanten/sleipner

Blazing fast dev docs application (alpha)
https://github.com/kontrollanten/sleipner

Last synced: 11 days ago
JSON representation

Blazing fast dev docs application (alpha)

• Host: GitHub
• URL: https://github.com/kontrollanten/sleipner
• Owner: kontrollanten
• License: mit
• Created: 2018-07-13T18:35:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-14T21:19:53.000Z (over 6 years ago)
• Last Synced: 2024-08-02T05:13:43.110Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 475 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - sleipner - Blazing fast dev docs application (alpha) (JavaScript)

README

        
# Sleipner - Blazing fast dev docs (alpha)

Icon made by [Freepik](http://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)

# Development

## Installation

```

yarn

```

## Run development environment

The following command will start `webpack-dev-server` and `electron`. `webpack-dev-server` will be ran inside the renderer process. The renderer process will be prepared with:

* HMR

* [React Developer Tools](https://github.com/facebook/react-devtools)

* [Redux DevTools chrome extension](https://github.com/zalmoxisus/redux-devtools-extension)

```

yarn dev

```

## Run production built renderer in electron

The following will build renderer into production and then run it with the `electron` cmd. An easier way to verify renderer production build.

```

yarn start

```

## Code validation

### Linting

```

yarn lint #both js and style linting

```

or

```

yarn lint:js

```

or

```

yarn lint:style

```

### Unit testing

```

yarn test

```

or

```

yarn test:main

```

or

```

yarn test:renderer

```

or

```

yarn test:renderer --watch

```

## Commiting

Commits are linted with [commitlint](https://github.com/marionebl/commitlint) with [conventional change](https://conventionalcommits.org/) rules. It's easiest to use the following command to commit your changes:

```

yarn git-cz

```