Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rebranding: Update working title to actual title #1

Merged
merged 8 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"mode": "pre",
"tag": "alpha",
"initialVersions": {
"@temp-nui/nui": "0.0.0",
"@temp-nui/storybook-utils": "0.0.0"
"@sit-onyx/components": "0.0.0",
JoCa96 marked this conversation as resolved.
Show resolved Hide resolved
"@sit-onyx/storybook-utils": "0.0.0"
},
"changesets": []
}
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Report a bug 🐞
description: You found a bug in NUI? You can report it with the form below.
description: You found a bug in Onyx? You can report it with the form below.
title: "[Bug]: "
labels:
- bug
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions & Discussions
url: https://github.com/schwarzit/nui/discussions/categories/q-a
url: https://github.com/schwarzit/onyx/discussions/categories/q-a
about: You have a question that might already be answered by the community? Take a look at the GitHub discussions!
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Request a new feature 🚀
description: >-
Do you want to request a new feature to be added to NUI? You can request it
Do you want to request a new feature to be added to Onyx? You can request it
with the form below.
title: "[Feature request]: "
labels:
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,29 @@ jobs:

- name: 🛠️ Build
run: pnpm run build
working-directory: packages/nui
working-directory: packages/components

- name: 🛠️ Build Storybook
run: pnpm run build:storybook
working-directory: packages/nui
working-directory: packages/components

- name: 🛠️ Build documentation
run: pnpm run build
working-directory: apps/docs

- name: 🚨 Run unit tests
run: pnpm run test:unit:coverage
working-directory: packages/nui
working-directory: packages/components

# install system dependencies for Playwright
# see: https://playwright.dev/python/docs/browsers#install-system-dependencies
- name: 📦 Install Playwright system dependencies
run: pnpm exec playwright install-deps
working-directory: packages/nui
working-directory: packages/components

- name: 🚨 Run component tests
run: pnpm run test:components
working-directory: packages/nui
working-directory: packages/components

- name: Run publint
run: pnpm run publint
Expand All @@ -66,15 +66,15 @@ jobs:
with:
name: test-results
path: |
packages/nui/coverage
packages/nui/playwright-report
packages/nui/test-results
packages/components/coverage
packages/components/playwright-report
packages/components/test-results

- name: Upload Storybook artifact
uses: actions/upload-artifact@v3
with:
name: storybook-static
path: packages/nui/storybook-static
path: packages/components/storybook-static

- name: Upload documentation artifact
uses: actions/upload-artifact@v3
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
branches:
- main
paths:
- "packages/nui/**"
- "packages/components/**"
workflow_dispatch:
inputs:
stage:
Expand Down Expand Up @@ -35,7 +35,7 @@ jobs:

- name: 🛠️ Build Storybook
run: pnpm run build:storybook
working-directory: packages/nui
working-directory: packages/components

- name: 🛠️ Build documentation
run: pnpm run build
Expand All @@ -45,7 +45,7 @@ jobs:
uses: actions/upload-artifact@v3
with:
name: storybook-static
path: packages/nui/storybook-static
path: packages/components/storybook-static

- name: Upload documentation artifact
uses: actions/upload-artifact@v3
Expand All @@ -64,7 +64,7 @@ jobs:
uses: actions/download-artifact@v3
with:
name: storybook-static
path: packages/nui/.cloud-foundry/storybook-static
path: packages/components/.cloud-foundry/storybook-static

- name: Deploy to Cloud Foundry
uses: ./.github/templates/cf-push
Expand All @@ -77,7 +77,7 @@ jobs:
# is only assigned when the workflow is triggered manually. When triggered e.g. on push
# the input will be unset so a fallback is needed here
cf-space: ${{ inputs.stage || 'dev' }}
working-directory: packages/nui/.cloud-foundry
working-directory: packages/components/.cloud-foundry

deploy_documentation:
name: Deploy documentation
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/prerelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
node-version-file: .node-version
cache: pnpm
registry-url: "https://registry.npmjs.org/"
scope: temp-nui
scope: sit-onyx
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# NUI Contributing Guide
# Onyx Contributing Guide

## Prerequisites / Technical setup

Expand Down Expand Up @@ -26,9 +26,9 @@ TypeScript cannot handle type information for `.vue` imports by default. In VS C

Pull Requests are very welcome!

1. You will need to [create a fork](https://github.com/larsrickert/temp-nui/fork) to commit and push your changes to.
1. You will need to [create a fork](https://github.com/SchwarzIT/onyx/fork) to commit and push your changes to.
2. When your changes affect the user you need to [add a changeset](./.changeset/README.md).
3. Then [create a PR](https://github.com/larsrickert/temp-nui/compare) to merge your changes back into our repository.
3. Then [create a PR](https://github.com/SchwarzIT/onyx/compare) to merge your changes back into our repository.

## Scripts

Expand Down Expand Up @@ -56,9 +56,9 @@ pnpm run format

<br />

### NUI
### Onyx

The following scripts are available inside [`packages/nui`](packages/nui):
The following scripts are available inside [`packages/components`](packages/components):

#### Type-Check, Compile and Minify for Production

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
</a>
</p>

# NUI
# Onyx

A Vue.js UI component library and Design System created by [Schwarz IT](https://it.schwarz).
A Design System and Vue.js UI component library created by [Schwarz IT](https://it.schwarz).
JoCa96 marked this conversation as resolved.
Show resolved Hide resolved

> **Work in progress**: This library is currently in early / active development. <br /> **Working title**: The name `NUI` is only a working title and will be changed in the future.
> **Work in progress**: This library is currently in early / active development. <br />

<br />

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/.cloud-foundry/manifest-dev.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
applications:
- name: nui-documentation-dev
- name: onyx-documentation-dev
memory: 64M
buildpack: https://github.com/cloudfoundry/staticfile-buildpack
6 changes: 3 additions & 3 deletions apps/docs/src/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { defineConfig } from "vitepress";
import packageJson from "../../../../packages/nui/package.json";
import packageJson from "../../../../packages/components/package.json";
import { getComponents } from "./utils";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "NUI",
title: "Onyx",
description: "Vue.js component library and design system",
themeConfig: {
externalLinkIcon: true,
Expand All @@ -26,7 +26,7 @@ export default defineConfig({
nav: [
{ text: "Getting Started", link: "/getting-started" },
{ text: "Report a bug", link: packageJson.bugs.url },
{ text: "Q&A", link: "https://github.com/schwarzit/nui/discussions/categories/q-a" },
{ text: "Q&A", link: "https://github.com/schwarzit/onyx/discussions/categories/q-a" },
],
socialLinks: [{ icon: "github", link: packageJson.repository.url }],
sidebar: [
Expand Down
6 changes: 4 additions & 2 deletions apps/docs/src/.vitepress/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ import fs from "node:fs";
import { fileURLToPath } from "node:url";

/**
* Gets a list of all available NUI component names.
* Gets a list of all available Onyx component names.
*/
export const getComponents = () => {
const path = fileURLToPath(new URL("../../../../packages/nui/src/components", import.meta.url));
const path = fileURLToPath(
new URL("../../../../packages/components/src/components", import.meta.url),
);
return fs.readdirSync(path);
};
19 changes: 9 additions & 10 deletions apps/docs/src/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,29 @@

::: warning Work in progress / Active development
This library is currently in early / active development.
The name `NUI` is only a working title and will be changed in the future.
:::

## Installation

<!--
Make sure that this chapter is kept up to date with installation steps in
packages/nui/README.md file.
packages/components/README.md file.
-->

Install the npm package with your corresponding package manager:

::: code-group

```sh [pnpm]
pnpm add nui
pnpm add @sit-onyx/components
```

```sh [npm]
npm install nui
npm install @sit-onyx/components
```

```sh [yarn]
yarn install nui
yarn install @sit-onyx/components
```

:::
Expand All @@ -35,9 +34,9 @@ After that, import the global CSS file:
::: code-group

```ts [main.ts]
import "nui/style.css";
// if you override some NUI styles (e.g. CSS variables),
// make sure to import your custom CSS file after the default "nui/style.css"
import "@sit-onyx/components/style.css";
// if you override some Onyx styles (e.g. CSS variables),
// make sure to import your custom CSS file after the default "@sit-onyx/components/style.css"
```

:::
Expand All @@ -46,10 +45,10 @@ Components are now ready to be used, e.g.:

```vue
<script lang="ts" setup>
import { NuiButton } from "nui";
import { OnyxButton } from "@sit-onyx/components";
</script>

<template>
<NuiButton label="Click me" />
<OnyxButton label="Click me" />
</template>
```
10 changes: 5 additions & 5 deletions apps/docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
layout: home

hero:
name: NUI
name: Onyx
text: Design system
tagline: A Vue.js component library and design system created by Schwarz IT.
image:
Expand All @@ -16,21 +16,21 @@ hero:

features:
- title: Powerful
details: NUIs advanced components are designed for enterprise grade applications. Including everything you need to build your next enterprise or even personal project.
details: Onyx's advanced components are designed for enterprise grade applications. Including everything you need to build your next enterprise or even personal project.
icon: 🚀
- title: Flexible and modular
details: You can build a whole application with NUI or only use a few of our customizable components into an existing application.
details: You can build a whole application with Onyx or only use a few of our customizable components into an existing application.
icon: 📦
- title: Themeable
details: We provide a well crafted theme out-of-the-box. Feel free to customize it to perfectly fit your look and feel.
icon: 🎨
- title: First class DX
details: Developer Experience is our top priority. NUI is fully written in TypeScript with great type support and generically typed components.
details: Developer Experience is our top priority. Onyx is fully written in TypeScript with great type support and generically typed components.
icon:
src: /icons/typescript.svg
alt: TypeScript logo
- title: Figma library
details: NUI also offers a Figma library for design purposes. Connecting Design and Development.
details: Onyx also offers a Figma library for design purposes. Connecting Design and Development.
icon:
src: /icons/figma.svg
alt: Figma logo
Expand Down
8 changes: 3 additions & 5 deletions apps/docs/src/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,9 @@ const members = [

# Meet the team 👋

NUI is maintained by [Schwarz IT](https://it.schwarz). Below you will find the members of our Core Team.
Onyx is maintained by [Schwarz IT](https://it.schwarz). Below you will find the members of our Core Team.

Are you looking for a bug report or feature request? Then please use our [GitHub issues](https://github.com/schwarzit/nui/issues).
For general Q&A, announcements and polls feel free to visit our community space via [GitHub discussions](https://github.com/schwarzit/nui/discussions/categories/q-a).

For business requests you can [contact Martin Hofmann](mailto:martin.hofmann@mail.schwarz).
Are you looking for a bug report or feature request? Then please use our [GitHub issues](https://github.com/schwarzit/onyx/issues).
For general Q&A, announcements and polls feel free to visit our community space via [GitHub discussions](https://github.com/schwarzit/onyx/discussions/categories/q-a).

<VPTeamMembers size="small" :members="members" />
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
applications:
- name: nui-storybook-dev
- name: onyx-storybook-dev
JoCa96 marked this conversation as resolved.
Show resolved Hide resolved
memory: 64M
buildpack: https://github.com/cloudfoundry/staticfile-buildpack
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { createPreview } from "@temp-nui/storybook-utils";
import { createPreview } from "@sit-onyx/storybook-utils";
import docsTemplate from "./docs-template.mdx";

import "@/styles/index.scss";
Expand Down
Loading