# sweetsoft-ui

> There are 2 main branches - `master` and `dev`. `master` - stable version of app `dev` - development version

Latest version **0.0.45** (published 2023-11-21) · 0 weekly downloads

## Install

```sh
npm install sweetsoft-ui
pnpm add sweetsoft-ui
yarn add sweetsoft-ui
bun add sweetsoft-ui
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.45 |
| Published | 2023-11-21 |
| First published | 2022-07-14 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 377.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | iash44 |

## Links

- npm: https://www.npmjs.com/package/sweetsoft-ui
- npm.io page: https://npm.io/package/sweetsoft-ui

## Dependencies (1)

- [svelte-markdown](https://npm.io/package/svelte-markdown.md) ^0.2.3

## Recent versions

- 0.0.45 (latest) — 2023-11-21
- 0.0.44 — 2023-11-21
- 0.0.43 — 2023-11-21
- 0.0.42 — 2023-11-21
- 0.0.41 — 2023-11-21
- 0.0.40 — 2023-11-21
- 0.0.39 — 2023-11-21
- 0.0.38 — 2023-11-21
- 0.0.37 — 2023-11-21
- 0.0.36 — 2022-12-06
- 0.0.35 — 2022-12-01
- 0.0.34 — 2022-12-01
- 0.0.33 — 2022-12-01
- 0.0.32 — 2022-09-21
- 0.0.31 — 2022-09-19
- … 28 more at https://npm.io/package/sweetsoft-ui/versions

## README

# Development flow
There are 2 main branches - `master` and `dev`.
`master` - stable version of app
`dev` - development version

> Development should be performed in branches.

> Any change should to to `dev` or `master` thru Pull Requests (**PR**).

# Build and Run

```bash
npm install # or yarn!
npm run dev
```

Open up [localhost:5173](http://127.0.0.1:5173/) and start clicking around.

# Start work on task


1. When developer should create branch from `master` and name it with pattern YYMMDD_<task_name>.

    Where:
    - YY - last 2 digits of current year
    - MM - 2 digits month
    - DD - 2 digits for day in month

    For instance it can be `190522_add_captions_to_form`.

2. All changes should be made in this branch. All When all changes made, developer should create **PR to `dev` branch**.
3. This PR should reviewed and when approved, it will in in `dev` branch. Also reviewer should create **PR to `master` branch**.
4. Build machine should publish it to dev environment and then it should pass tests (or it can be tested locally).
5. When issue is resolved **PR to `master` branch** should be merged.


# Coding

## Documentation is listed in docs folder
[Project documentation](doc/readme.md)

## For development it is recommended to use VS code
[Recommended VS code plugins](doc/recomended-vs-code-plugins.md)

# Package and usages of the library.
This repository contains set of components that can be used as following:
- standalone application withing SvelteKit (mostly for testing)
- Storybook pages - for testing UI components
- library that published to [NPM](https://www.npmjs.com/package/sweetsoft-ui)

# Library purpose
Assumed that the library can be used as components for other projects.

## UI

We use [Svelte](https://github.com/sveltejs/svelte) framework for visualization and [SvelteKit](https://kit.svelte.dev/docs/introduction).


### Components

Components are created in folder [src/lib/components](src/lib/components). Component is one file or folder with few files. More details [Svelte examples](https://svelte.dev/examples) and [Svelte API](https://svelte.dev/docs) and [Svelte tutorial](https://svelte.dev/tutorial).

## Client side logic

Client side logic implemented with [TypeScript](https://www.typescriptlang.org/) and mostly located in folder [src/lib/](src/lib/).


## Structure

We use SvelteKit thus folder structure in SvelteKit expects to find two directories in the root of your project —  `src` and `static`.

All libraries and components that can be re-used are located in folder `lib`.

We also have [Storybook]() stories in [src stories](/src/stories/) folder.
- you can run storybook tests using npm run storybook.
- stories are used for testing individual components.
- storybook used its default 6006 port

### Routing

Since we use SvelteKit, we use its [routing](https://kit.svelte.dev/docs/routing).

#### src/routes
See link above.
...

### static

The [static](static) directory contains any static assets that should be available. These are served using [sirv](https://github.com/lukeed/sirv).

## Production mode and deployment

To start a production version of your app, run `npm run build && npm start`. This will disable live reloading, and activate the appropriate bundler plugins.

Production  mode support expected to use [sveltekit adapters](https://kit.svelte.dev/docs/adapters).

---
_Source: https://npm.io/package/sweetsoft-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._