generated from Sikessem/create-skeleton
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
SIGUI Kessé Emmanuel
committed
Jan 20, 2023
1 parent
1f0b50b
commit 5db088f
Showing
20 changed files
with
1,395 additions
and
506 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,3 +30,5 @@ dist | |
tsconfig.tsbuildinfo | ||
*.spec.tsx | ||
*.spec.ts | ||
*.config.ts | ||
*.config.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Playwright Tests | ||
on: | ||
push: | ||
branches: [ main, master ] | ||
pull_request: | ||
branches: [ main, master ] | ||
jobs: | ||
test: | ||
timeout-minutes: 60 | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16 | ||
- name: Install dependencies | ||
run: pnpm install | ||
- name: Install Playwright Browsers | ||
run: pnpm dlx playwright install --with-deps | ||
- name: Run Playwright tests | ||
run: pnpm dlx playwright test | ||
- uses: actions/upload-artifact@v3 | ||
if: always() | ||
with: | ||
name: playwright-report | ||
path: playwright-report/ | ||
retention-days: 30 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,3 +32,6 @@ dist-ssr/ | |
*.njsproj | ||
*.sln | ||
*.sw? | ||
/test-results/ | ||
/playwright-report/ | ||
/playwright/.cache/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
<div align="center"><a href="https://sikessem.com/" title="Sikessem"><img src="https://github.com/sikessem/.github/blob/HEAD/sikessem.svg" alt="Sikessem logo" height="256"/></a></div> | ||
<div align="center"><a href="https://sikessem.com/" title="Sikessem"><img src="https://github.com/sikessem/art/blob/HEAD/images/sikessem.svg" alt="Sikessem logo" height="256"/></a></div> | ||
<div align="center"> | ||
|
||
[![actions-img]][actions-url] | ||
|
@@ -13,59 +13,68 @@ | |
</div> | ||
<div align="center"><sub>Built with ❤︎ by <a href="https://twitter.com/sikessem_tweets">Sikessem</a>.</sub></div> | ||
|
||
[actions-img]: https://img.shields.io/github/actions/workflow/status/sikessem/js-skeleton/tests.yml?branch=main&style=for-the-badge | ||
[actions-url]: https://github.com/sikessem/js-skeleton/actions "Skeleton status" | ||
[actions-img]: https://img.shields.io/github/actions/workflow/status/sikessem/testwind/tests.yml?branch=main&style=for-the-badge | ||
[actions-url]: https://github.com/sikessem/testwind/actions "Testwind status" | ||
|
||
[ts-img]: https://img.shields.io/badge/TypeScript-294E80.svg?style=for-the-badge&logo=typescript | ||
[ts-url]: https://github.com/sikessem/js-skeleton/search?l=typescript "TypeScript code" | ||
[ts-url]: https://github.com/sikessem/testwind/search?l=typescript "TypeScript code" | ||
|
||
[js-img]: https://img.shields.io/badge/JavaScript-yellow.svg?style=for-the-badge&logo=javascript | ||
[js-url]: https://github.com/sikessem/js-skeleton/search?l=javascript "JavaScript code" | ||
[js-url]: https://github.com/sikessem/testwind/search?l=javascript "JavaScript code" | ||
|
||
[npm-img]: https://img.shields.io/npm/v/@sikessem/create-skeleton/latest.svg?style=for-the-badge&logo=npm | ||
[npm-url]: https://www.npmjs.com/package/@sikessem/create-skeleton/v/latest "npm" | ||
[npm-img]: https://img.shields.io/npm/v/testwind/latest.svg?style=for-the-badge&logo=npm | ||
[npm-url]: https://www.npmjs.com/package/testwind/v/latest "npm" | ||
|
||
[dl-img]: https://img.shields.io/npm/dt/@sikessem/create-skeleton?style=for-the-badge | ||
[dl-url]: https://npmjs.com/package/@sikessem/create-skeleton | ||
[dl-img]: https://img.shields.io/npm/dt/testwind?style=for-the-badge | ||
[dl-url]: https://npmjs.com/package/testwind | ||
|
||
[l-img]: https://img.shields.io/npm/l/@sikessem/js-skeleton?color=blueviolet&style=for-the-badge | ||
[l-img]: https://img.shields.io/npm/l/testwind?color=blueviolet&style=for-the-badge | ||
[l-url]: [license-url] "MIT License" | ||
|
||
[pr-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?color=brightgreen&style=for-the-badge | ||
[pr-url]: [contrib-url] "PRs welcome!" | ||
|
||
[synk-img]: https://img.shields.io/snyk/vulnerabilities/github/sikessem/js-skeleton?label=Synk%20Vulnerabilities&style=for-the-badge | ||
[synk-url]: https://snyk.io/test/github/sikessem/js-skeleton?targetFile=package.json "synk" | ||
[synk-img]: https://img.shields.io/snyk/vulnerabilities/github/sikessem/testwind?label=Synk%20Vulnerabilities&style=for-the-badge | ||
[synk-url]: https://snyk.io/test/github/sikessem/testwind?targetFile=package.json "synk" | ||
|
||
[conduct-url]: https://github.com/sikessem/.github/blob/main/CODE_OF_CONDUCT.md | ||
[contrib-url]: https://github.com/sikessem/.github/blob/HEAD/CONTRIBUTING.md | ||
[discuss-url]: https://github.com/sikessem/community/discussions | ||
[license-url]: https://github.com/sikessem/js-skeleton/blob/HEAD/LICENSE | ||
[license-url]: https://github.com/sikessem/testwind/blob/HEAD/LICENSE | ||
|
||
# ️📦 Sikessem TS/JS Skeleton | ||
# ️🧪 Testwind | ||
|
||
Sikessem's TypeScript/JavaScript Skeleton allows you to create JavaScript packages using Vite, Vitest and TailwindCSS. | ||
Quickly test TailwindCSS codes, components, utilities with Vite, Vitest and TailwindCSS. | ||
|
||
## 🔖 Contents | ||
|
||
- [Requirements](#-requirements) | ||
- [Installation](#%EF%B8%8F-installation) | ||
- [Usage](#-usage) | ||
- [Testing](#-testing) | ||
- [Contribution](#-contribution) | ||
- [Security Reports](#-security-reports) | ||
- [️🧪 Testwind](#️-testwind) | ||
- [🔖 Contents](#-contents) | ||
- [📋 Requirements](#-requirements) | ||
- [⚡️ Installation](#️-installation) | ||
- [🏗️ Project Structure](#️-project-structure) | ||
- [🧑💻 Usage](#-usage) | ||
- [🌐 Starting server](#-starting-server) | ||
- [🧪 Testing](#-testing) | ||
- [👏 Contribution](#-contribution) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [👥 Contributing Guide](#-contributing-guide) | ||
- [🔒️ Good First Issues](#️-good-first-issues) | ||
- [💬 Discussions](#-discussions) | ||
- [🔐 Security Reports](#-security-reports) | ||
- [📄 License](#-license) | ||
|
||
## 📋 Requirements | ||
|
||
> - **Requires [Node JS 18+](https://nodejs.org/)** (at least 18.12.1 recommended to avoid potential bugs). | ||
> - **Requires [pnpm@7.18.2](https://pnpm.io/)** to manage JS and TS dependencies. | ||
> - **Requires [Node JS 18+](https://nodejs.org/)** (at least 18.13.0 recommended to avoid potential bugs). | ||
> - **Requires [pnpm@7.25.0](https://pnpm.io/)** to manage JS and TS dependencies. | ||
## ⚡️ Installation | ||
|
||
Install [Skeleton](https://npmjs.com/package/@sikessem/create-skeleton) using [pnpm](https://pnpm.io/): | ||
Install [Testwind](https://npmjs.com/package/testwind) using [pnpm](https://pnpm.io/): | ||
|
||
```shell | ||
pnpm create @sikessem/skeleton | ||
pnpm add -D testwind | ||
``` | ||
|
||
## 🏗️ Project Structure | ||
|
@@ -96,7 +105,7 @@ Inside your project, you'll see the following directory structure: | |
Run the server in development mode: | ||
|
||
```bash | ||
php artisan serve --host=ahlabik.test --port=80 | ||
pnpm start | ||
``` | ||
|
||
## 🧪 Testing | ||
|
@@ -127,7 +136,7 @@ php artisan serve --host=ahlabik.test --port=80 | |
|
||
## 👏 Contribution | ||
|
||
The main purpose of this repository is to continue evolving Skeleton. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Skeleton. | ||
The main purpose of this repository is to continue evolving Testwind. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Testwind. | ||
|
||
### [Code of Conduct][conduct-url] | ||
|
||
|
@@ -136,26 +145,26 @@ Please read the [full text][conduct-url] so that you can understand what actions | |
|
||
### 👥 [Contributing Guide][contrib-url] | ||
|
||
Read our [**Contributing Guide**][contrib-url] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Skeleton. | ||
Read our [**Contributing Guide**][contrib-url] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Testwind. | ||
|
||
### 🔒️ Good First Issues | ||
|
||
We have a list of [good first issues][gfi] that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process. | ||
|
||
[gfi]: https://github.com/sikessem/js-skeleton/labels/good%20first%20issue | ||
[gfi]: https://github.com/sikessem/testwind/labels/good%20first%20issue | ||
|
||
### 💬 Discussions | ||
|
||
Larger discussions and proposals are discussed in [**@sikessem/community**][discuss-url]. | ||
|
||
## 🔐 Security Reports | ||
|
||
If you discover a security vulnerability within Skeleton, please email [SIGUI Kessé Emmanuel](https://github.com/SIGUIKE) at [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. | ||
If you discover a security vulnerability within Testwind, please email [SIGUI Kessé Emmanuel](https://github.com/siguikesse) at [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. | ||
|
||
## 📄 License | ||
|
||
Skeleton is MIT licensed, as found in the [LICENSE][license-url] file. | ||
Testwind is MIT licensed, as found in the [LICENSE][license-url] file. | ||
|
||
*** | ||
|
||
Skeleton was developed by [Sikessem](https://sikessem.com). | ||
Testwind was developed by [Sikessem](https://sikessem.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,75 @@ | ||
{ | ||
"name": "@sikessem/create-skeleton", | ||
"type": "module", | ||
"private": true, | ||
"engines": { | ||
"node": "^16.0.0 || >=18.0.0" | ||
}, | ||
"packageManager": "[email protected]", | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"license": "MIT", | ||
"homepage": "https://npmjs.com/package/@sikessem/create-skeleton", | ||
"repository": "https://github.com/sikessem/js-skeleton", | ||
"description": "📦️ The Sikessem Skeleton for creating new TypeScript/JavaScript module.", | ||
"keywords": [ | ||
"sikessem", | ||
"skeleton", | ||
"javascript", | ||
"typescript", | ||
"ske", | ||
"js", | ||
"ts" | ||
], | ||
"author": { | ||
"name": "SIGUI Kessé Emmanuel", | ||
"email": "[email protected]", | ||
"url": "https://sikessem.com" | ||
}, | ||
"scripts": { | ||
"dev": "concurrently vite vitest", | ||
"prod": "tsc && vite build", | ||
"fmt": "prettier --write .", | ||
"lint": "eslint . --ext .ts,.js --fix", | ||
"test": "test:lint && test:fmt && test:unit", | ||
"test:lint": "eslint . --ext .ts,.js", | ||
"test:fmt": "prettier --check .", | ||
"test:unit": "vitest run", | ||
"test:cov": "vitest run --coverage" | ||
}, | ||
"devDependencies": { | ||
"@tailwindcss/forms": "^0.5.3", | ||
"@tailwindcss/nesting": "0.0.0-insiders.565cd3e", | ||
"@tailwindcss/typography": "^0.5.8", | ||
"@types/node": "^18.11.18", | ||
"@typescript-eslint/eslint-plugin": "^5.47.1", | ||
"@typescript-eslint/parser": "^5.47.1", | ||
"autoprefixer": "^10.4.13", | ||
"concurrently": "^7.6.0", | ||
"cssnano": "^5.1.14", | ||
"eslint": "^8.30.0", | ||
"eslint-config-prettier": "^8.5.0", | ||
"eslint-config-standard-with-typescript": "^24.0.0", | ||
"eslint-plugin-import": "^2.26.0", | ||
"eslint-plugin-n": "^15.6.0", | ||
"eslint-plugin-promise": "^6.1.1", | ||
"postcss": "^8.4.20", | ||
"postcss-import": "^15.1.0", | ||
"postcss-nested": "^6.0.0", | ||
"prettier": "^2.8.1", | ||
"prettier-plugin-tailwindcss": "^0.2.1", | ||
"tailwindcss": "^3.2.4", | ||
"typescript": "^4.9.4", | ||
"vite": "^4.0.3", | ||
"vitest": "^0.26.2" | ||
} | ||
"name": "testwind", | ||
"type": "module", | ||
"version": "0.0.0", | ||
"engines": { | ||
"node": "^16.0.0 || >=18.0.0" | ||
}, | ||
"packageManager": "[email protected]", | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"license": "MIT", | ||
"homepage": "https://npmjs.com/package/testwind", | ||
"repository": "https://github.com/sikessem/testwind", | ||
"description": "📦️ The Sikessem Skeleton for creating new TypeScript/JavaScript module.", | ||
"keywords": [ | ||
"sikessem", | ||
"tailwindcss", | ||
"javascript", | ||
"typescript", | ||
"plugin", | ||
"tester", | ||
"checker", | ||
"test", | ||
"css", | ||
"js", | ||
"ts" | ||
], | ||
"author": { | ||
"name": "SIGUI Kessé Emmanuel", | ||
"email": "[email protected]", | ||
"url": "https://kesse.sigui.ci" | ||
}, | ||
"scripts": { | ||
"dev": "concurrently vite vitest", | ||
"prod": "tsc && vite build", | ||
"start": "vite --open preview", | ||
"fmt": "prettier --write .", | ||
"lint": "eslint . --ext .ts,.js --fix", | ||
"test": "pnpm test:lint && pnpm test:fmt && pnpm test:unit && pnpm test:e2e", | ||
"test:lint": "eslint . --ext .ts,.js", | ||
"test:fmt": "prettier --check .", | ||
"test:unit": "tsc && vitest run", | ||
"test:e2e": "playwright test" | ||
}, | ||
"devDependencies": { | ||
"@playwright/test": "^1.29.2", | ||
"@tailwindcss/forms": "^0.5.3", | ||
"@tailwindcss/nesting": "0.0.0-insiders.565cd3e", | ||
"@tailwindcss/typography": "^0.5.9", | ||
"@types/node": "^18.11.18", | ||
"@typescript-eslint/eslint-plugin": "^5.48.2", | ||
"@typescript-eslint/parser": "^5.48.2", | ||
"autoprefixer": "^10.4.13", | ||
"concurrently": "^7.6.0", | ||
"cssnano": "^5.1.14", | ||
"dotenv": "^16.0.3", | ||
"dotenv-expand": "^10.0.0", | ||
"eslint": "^8.32.0", | ||
"eslint-config-prettier": "^8.6.0", | ||
"eslint-config-standard-with-typescript": "^31.0.0", | ||
"eslint-plugin-import": "^2.27.5", | ||
"eslint-plugin-n": "^15.6.1", | ||
"eslint-plugin-promise": "^6.1.1", | ||
"postcss": "^8.4.21", | ||
"postcss-import": "^15.1.0", | ||
"postcss-nested": "^6.0.0", | ||
"prettier": "^2.8.3", | ||
"prettier-plugin-tailwindcss": "^0.2.1", | ||
"tailwindcss": "^3.2.4", | ||
"typescript": "^4.9.4", | ||
"vite": "^4.0.4", | ||
"vitest": "^0.27.2" | ||
} | ||
} |
Oops, something went wrong.