https://github.com/sfttech/sftkit
Software Development Kit for SFT projects
https://github.com/sfttech/sftkit
Last synced: about 1 year ago
JSON representation
Software Development Kit for SFT projects
- Host: GitHub
- URL: https://github.com/sfttech/sftkit
- Owner: SFTtech
- License: other
- Created: 2024-06-04T15:02:31.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T20:08:55.000Z (over 1 year ago)
- Last Synced: 2025-04-23T00:17:02.054Z (about 1 year ago)
- Language: Python
- Size: 398 KB
- Stars: 3
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SFT Kit
Software Development Kit for SFT projects.
## Features
- none
## Contributing
This repo is using [NX](https://nx.dev/) as mono-repo management tooling.
- First install nodejs in the current lts version (20).
Then install node dependencies via
```bash
npm install
```
To start hacking on the python parts simply use [pdm](https://pdm-project.org) to install all dependencies.
```bash
pdm install
```
### Packages in this repo
| Name | Directory | Package Name | Technology |
| --------------- | --------------------- | ------------------------- | ---------- |
| sftkit | `sftkit` | `sftkit` | Python |
| components | `web/components` | `@sftkit/components` | TypeScript |
| form-components | `web/form-components` | `@sftkit/form-components` | TypeScript |
| modal-provider | `web/modal-provider` | `@sftkit/modal-provider` | TypeScript |
| utils | `web/utils` | `@sftkit/utils` | TypeScript |
#### Linting
To run respective linters on a project run
```bash
npx nx lint
```
#### Formatting
```bash
npx nx run sftkit:format
npx nx format
```
#### Testing
```bash
npx nx test
```
#### Building
```bash
npx nx build
```
## Contact
If you have the desire to perform semi-human interaction,
join our **Matrix** chatroom!
- [`#sfttech:matrix.org`](https://riot.im/app/#/room/#sfttech:matrix.org)
For ideas, problems, ..., use the [issue tracker](https://github.com/SFTtech/sftkit/issues)!
## License
**MIT** license; see [LICENSE](LICENSE).