19 lines
1.4 KiB
Markdown
19 lines
1.4 KiB
Markdown
|
## Requirements
|
||
|
|
|
||
|
|
If you are simply including this library in your project, all you need is a recent version of Node.js. **[Node.js >14.18.0]({{ repository.project.node }})** is sometimes required and is the only version range we actively support. Albeit, it is highly probable that lower versions will work as well depending on the requirements that this project imports.
|
||
|
|
|
||
|
|
### Developer Requirements
|
||
|
|
|
||
|
|
The following versions of Node.js and Python are required for development:
|
||
|
|
|
||
|
|
- **[Node.js >14.18.0]({{ repository.project.node }})**
|
||
|
|
- **[Python >3.10.0]({{ repository.project.python }})**
|
||
|
|
|
||
|
|
Other versions may work, but only the above versions are supported. Most development dependencies are installed automatically by our `Taskfile.yml` set-up (even Node.js and Python). Run `bash start.sh` to install **[Bodega](https://github.com/ProfessorManhattan/Bodega)** (an improved fork of [go-task](https://github.com/go-task/task)) and run the initialization sequence. The taskfiles will automatically install dependencies as they are needed, based on what development tasks you are running. For more information, check out the [CONTRIBUTING.md]({{ repository.github }}/blob/main/docs/CONTRIBUTING.md) or simply run:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
npm run help
|
||
|
|
```
|
||
|
|
|
||
|
|
`npm run help` will ensure Bodega is installed and then open an interactive dialog where you can explore and learn about various developer commands.
|