Coupeeeez

Description

A program to make Coupeeeez streams.

Prerequisites

• Node.js (Latest LTS)

Installation

npm i -g coupeeeez

Usage

coupeeeez help

Then read the instructions provided in the help command.

Start server

coupeeeez start

Then go to http://localhost:3000 in your web browser, you'll see a home page with links, have fun.

Development

Contributing

1. Fork the repository: https://gitlab.com/coupeeeez/coupeeeez
2. Clone your fork locally
3. Create a new branch to make your changes
4. Make, your changes, commit, push and open a merge request
5. Wait for review and apply any requested changes
6. Once approved, your changes will be merged

Start coding

We try to do our best to make code using Canon TDD methodology.

That's why you'll find how to start the app using tests.

npm i
npm run test:component

We use Component Testing by Marting Fowler, so, please read this article before starting make any contribution.

Then specify a behavior by adding your tests in the cypress/e2e folder.

You can see cypress documentation to learn more about writing tests with Cypress.

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 if you want to add unit tests.

Build the application

npm run build

Start the built application

npm start

Make a package of the application

npm pack

Publish the package to npm registry

First of all, upgrade the version in the package.json file according to semver.

Then install with npm install and build with npm run build, then publish:

npm publish

You need to be a maintainer to publish the package.