| 1 | # Thanks for contributing to @cotype/core
|
| 2 |
|
| 3 | ## Commits + Releases
|
| 4 |
|
| 5 | We are using [semantic-release](https://semantic-release.gitbook.io/semantic-release/)
|
| 6 | to create npm releases based on the commit history.
|
| 7 |
|
| 8 | This requires that you write your commits following the
|
| 9 | [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
|
| 10 |
|
| 11 | Here is an example of the release type that will be done based on a commit messages:
|
| 12 |
|
| 13 | | Commit message | Release type |
|
| 14 | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
|
| 15 | | `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
|
| 16 | | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
|
| 17 | | `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
|
| 18 |
|
| 19 | See [Semantic release docs](https://github.com/semantic-release/semantic-release#how-does-it-work) for more details
|
| 20 |
|
| 21 | ## Architecture
|
| 22 |
|
| 23 | This repo provides the `@cotype/core` package
|
| 24 |
|
| 25 | internally we have two other packages: client and demo
|
| 26 |
|
| 27 | - **demo**: an example/dev configuration for the server
|
| 28 | - **client**: the frontend which is bundled within the server releases
|
| 29 |
|
| 30 | ## Development
|
| 31 |
|
| 32 | To bootstrap the project and start a development server do the following:
|
| 33 |
|
| 34 | ```bash
|
| 35 | npm install #once
|
| 36 | npm start
|
| 37 | ```
|
| 38 |
|
| 39 | ## Login
|
| 40 |
|
| 41 | When the server is started for the first time, the necessary tables are created and an inital admin user is created with the following credentials:
|
| 42 |
|
| 43 | ```
|
| 44 | Email: admin@cotype.dev
|
| 45 | Password: admin
|
| 46 | ```
|