coupeeeez 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +91 -0
- package/package.json +8 -1
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Coupeeeez
|
|
2
|
+
|
|
3
|
+
## Description
|
|
4
|
+
|
|
5
|
+
A program to make Coupeeeez streams.
|
|
6
|
+
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
* [Node.js](https://nodejs.org/) (Latest LTS)
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```shell
|
|
14
|
+
npm i -g coupeeeez
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```shell
|
|
20
|
+
coupeeeez help
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then read the instructions provided in the help command.
|
|
24
|
+
|
|
25
|
+
### Start server
|
|
26
|
+
|
|
27
|
+
```shell
|
|
28
|
+
coupeeeez start
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Then go to http://localhost:3000 in your web browser, you'll see a home page with links, have fun.
|
|
32
|
+
|
|
33
|
+
## Development
|
|
34
|
+
|
|
35
|
+
### Contributing
|
|
36
|
+
|
|
37
|
+
1. Fork the repository: https://gitlab.com/coupeeeez/coupeeeez
|
|
38
|
+
2. Clone your fork locally
|
|
39
|
+
3. Create a new branch to make your changes
|
|
40
|
+
4. Make, your changes, commit, push and open a merge request
|
|
41
|
+
5. Wait for review and apply any requested changes
|
|
42
|
+
6. Once approved, your changes will be merged
|
|
43
|
+
|
|
44
|
+
### Start coding
|
|
45
|
+
|
|
46
|
+
We try to do our best to make code using [Canon TDD](https://tidyfirst.substack.com/p/canon-tdd) methodology.
|
|
47
|
+
|
|
48
|
+
That's why you'll find how to start the app using tests.
|
|
49
|
+
|
|
50
|
+
```shell
|
|
51
|
+
npm i
|
|
52
|
+
npm run test:component
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
> We use [Component Testing by Marting Fowler](https://martinfowler.com/bliki/ComponentTest.html), so, please read this article before starting make any contribution.
|
|
56
|
+
|
|
57
|
+
Then specify a behavior by adding your tests in the `cypress/e2e` folder.
|
|
58
|
+
|
|
59
|
+
You can see [cypress documentation](https://docs.cypress.io/guides/overview/why-cypress) to learn more about writing tests with Cypress.
|
|
60
|
+
|
|
61
|
+
Currently, there is no `unit tests` because all component tests are covering the application. So feel free to add a unit test framework like [vitest](https://vitest.dev/) if you want to add unit tests.
|
|
62
|
+
|
|
63
|
+
### Build the application
|
|
64
|
+
|
|
65
|
+
```shell
|
|
66
|
+
npm run build
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Start the built application
|
|
70
|
+
|
|
71
|
+
```shell
|
|
72
|
+
npm start
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Make a package of the application
|
|
76
|
+
|
|
77
|
+
```shell
|
|
78
|
+
npm pack
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Publish the package to npm registry
|
|
82
|
+
|
|
83
|
+
First of all, upgrade the version in the `package.json` file according to [semver](https://semver.org/).
|
|
84
|
+
|
|
85
|
+
Then install with `npm install` and build with `npm run build`, then publish:
|
|
86
|
+
|
|
87
|
+
```shell
|
|
88
|
+
npm publish
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
> You need to be a maintainer to publish the package.
|
package/package.json
CHANGED
|
@@ -1,10 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "coupeeeez",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Anthony REY",
|
|
7
7
|
"type": "module",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://gitlab.com/coupeeeez/coupeeeez.git"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://gitlab.com/coupeeeez/coupeeeez/-/issues"
|
|
14
|
+
},
|
|
8
15
|
"scripts": {
|
|
9
16
|
"start": "node app.ts",
|
|
10
17
|
"build": "tsc && npm run stream:build",
|