Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sliit-foss/npm-catalogue
A curated list of NPM packages developed by the SLIIT FOSS community. Additionally, it houses the core libraries of the Timekeeper ecosystem
https://github.com/sliit-foss/npm-catalogue
bashaway hacktoberfest npm-packages timekeeper turborepo
Last synced: 2 months ago
JSON representation
A curated list of NPM packages developed by the SLIIT FOSS community. Additionally, it houses the core libraries of the Timekeeper ecosystem
- Host: GitHub
- URL: https://github.com/sliit-foss/npm-catalogue
- Owner: sliit-foss
- License: mit
- Created: 2023-02-05T10:37:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T19:08:09.000Z (5 months ago)
- Last Synced: 2024-10-08T00:03:59.679Z (2 months ago)
- Topics: bashaway, hacktoberfest, npm-packages, timekeeper, turborepo
- Language: JavaScript
- Homepage: https://www.npmjs.com/~sliit.foss
- Size: 1.91 MB
- Stars: 4
- Watchers: 3
- Forks: 8
- Open Issues: 18
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - sliit-foss/npm-catalogue - A curated list of NPM packages developed by the SLIIT FOSS community. Additionally, it houses the core libraries of the Timekeeper ecosystem (JavaScript)
README
# Catalogue
### A curated list of NPM packages developed by the SLIIT FOSS community
## Getting started
- Run `pnpm install` to install all dependencies
## Test and Deploy
- Run `pnpm test` to run all test suites in all packages
- Run `pnpm build` to build all packages
- Run `pnpm --filter test` to run test suites for a particular package
- Deployment is handled automatically by [GitHub Actions](.github\workflows\release.yml) when a commit is pushed to the `main` branch
## Git commit messages
- We follow conventional commits during our development workflow as it helps us automate our release process. More information can be found at their official [documentation](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples)
- Primary commit message prefixes for version bumping are as follows:
```js
- Feat! - bump major version
```
```js
- Feat - bump minor version
```
```js
- Fix - bump patch version
```
- Refer the [commitlint.config.js](https://github.com/sliit-foss/npm-catalogue/blob/main/commitlint.config.js) file for a full list of supported commit message prefixes
## Disable version bumping for specific commit
- Add the following to a commit message as follows: "--no-bump"
```bash
git commit -m "Feat: some feature --no-bump"
```
## Linting and Formatting
- Run `pnpm lint` to lint all packages
- Run `pnpm format` to format all packages
## Remote Caching
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
```bash
pnpm dlx turbo login
```
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
```bash
pnpm dlx turbo link
```