Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 1.6 KB

README.md

File metadata and controls

75 lines (48 loc) · 1.6 KB
Raw

SFT Kit

Software Development Kit for SFT projects.

Features

  • none

Contributing

This repo is using NX as mono-repo management tooling.

  • First install nodejs in the current lts version (20).

Then install node dependencies via

npm install

To start hacking on the python parts simply use pdm to install all dependencies.

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

npx nx lint <project-name>

Formatting

npx nx run sftkit:format
npx nx format

Testing

npx nx test <project-name>

Building

npx nx build <project-name>

Contact

If you have the desire to perform semi-human interaction, join our Matrix chatroom!

For ideas, problems, ..., use the issue tracker!

License

MIT license; see LICENSE.