Skip to content

Latest commit

 

History

History
161 lines (104 loc) · 5.47 KB

README.md

File metadata and controls

161 lines (104 loc) · 5.47 KB
Raw
Sikessem logo

actions-img ts-img js-img npm-img dl-img l-img pr-img synk-img

Built with ❤︎ by Sikessem.

️📦 Sikessem TS/JS Skeleton

Sikessem's TypeScript/JavaScript Skeleton allows you to create JavaScript packages using Vite, Vitest and TailwindCSS.

🔖 Contents

📋 Requirements

  • Requires Node JS 18+ (at least 18.12.1 recommended to avoid potential bugs).
  • Requires pnpm@7.18.2 to manage JS and TS dependencies.

⚡️ Installation

Install Skeleton using pnpm:

pnpm create @sikessem/skeleton

🏗️ Project Structure

Below is the basic JavaScript skeleton architecture for a new Sikessem module.

Inside your project, you'll see the following directory structure:

├── public/
│   └── ...
├── src/
│   └── ...
└── tests/
    └── ...

  • src: Provides project source files (components, plugins, etc.)

  • tests: Tests directory (unit, E2E, etc.)

  • public: Any static assets, like images, can be placed in the public directory.

🧑‍💻 Usage

🌐 Starting server

Run the server in development mode:

php artisan serve --host=ahlabik.test --port=80

🧪 Testing

  • 🧹 Keep a modern codebase with Prettier:

    pnpm test:lint

  • ⚗️ Run static analysis using ESLint:

    pnpm test:fmt

  • ✅ Run unit tests using VITEST

    pnpm test:unit

  • 🚀 Run the entire test suite:

    pnpm test

👏 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.

Code of Conduct

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

👥 Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Skeleton.

🔒️ Good First Issues

We have a list of good first issues 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.

💬 Discussions

Larger discussions and proposals are discussed in @sikessem/community.

🔐 Security Reports

If you discover a security vulnerability within Skeleton, please email SIGUI Kessé Emmanuel at ske@sikessem.com. All security vulnerabilities will be promptly addressed.

📄 License

Skeleton is MIT licensed, as found in the LICENSE file.

Skeleton was developed by Sikessem.