Instructions for new developers

[sstenchlak]

Project organization and workflow

Source code and issues: https://github.com/mff-uk/dataspecer

We use Monorepository managed by Turborepo. This means that there are multiple projects inside a single repository. If you want to use one of those projects, you must link them as a dependency in your package.json file.

Contact me to discuss where your code will be and ask me about setting up a blank project.

Deployments

• https://tool.dataspecer.com/ main branch deployed, for our purposes
• https://demo.dataspecer.com/ for demonstration purposes, do not use
• https://slovník.gov.cz/generujeme/ MVČR instance
• Each branch deployed by Cloudflare pages (see the checkmark next to commit hash)

• Automatic testing

Documentation for end users

https://github.com/mff-uk/dataspecer-docs

• main branch deployed to https://dataspecer.com/

Technologies

• TypeScript (better JavaScript) - both backend & frontend - tutorial https://javascript.info/
• React.js - frontend library - documentation https://react.dev/learn

• MUI - UI library for React. Tailwind.css is recommended for new projects.
• Lerna - monorepo manager. Turborepo will replace it.
• Next.js for full-stack projects.

Contributing

• You can commit directly to the main branch.
• For multiple-commit changes, use pull request (you do not need approval).