Frontend repository for eHOKS project.
npm install installs required npm dependencies for oppija and virkailija
npm run start:oppija or npm run start:virkailija will run the specified subdirectory's start -script
npm run styleguide launches react-styleguidist styleguide server in localhost:6060
npm lint runs linter for the code
npm run lint:fix will try to automatically fix linter errors
npm test runs the Jest test suite
npm run prettier:check will check for Prettier code format errors
npm run prettier:fix will fix prettier errors
There are two frontend apps included in the repository:
oppija directory includes views for students and workplace instructors, it will be hosted at e.g. https://testiopintopolku.fi/ehoks/
virkailija directory includes eHOKS views for education providers, it will be visible in Opintopolku's virkailija UI, e.g. https://virkailija.testiopintopolku.fi
Running npm install in repository's root level will install dependencies for both oppija and virkailija apps. There's also shared directory that includes styled-components theme and UI components that are used by both apps.
See README files in oppija and virkailija directories for app specific instructions.
- React for rendering views
- mobx-state-tree for state handling
- Jest for tests
- TypeScript to provide type safety and ease maintenance & refactoring
- Webpack for building the JS bundle
See TECHNICAL_DECISIONS.md document for more in-depth overview of the frontend architecture.
If you don't want code formatting commits to clutter git blame you can run git config blame.ignoreRevsFile .git-blame-ignore-revs . Works in git >= 2.23