Documentation

• Features used in the project

Running the project

requires Node >= 14

clone the repo git clone git@github.com:flashcards-app/frontend.git flashcards-frontend

then

cd flashcards-frontend
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
pnpm run dev

And, enjoy :)

Contributing

Feel free to submit PRs for small issues. For large issues or features, open an issue first.

Option 1 - Simple Typo Fixes

For small issues, like a typo or broken link, use Github's inline file editor or web editor (open by pressing . in your fork's code tab) to make the fix and submit a pull request.

Option 2 - Work on your own Fork

For more complex contributions, like new features, you should work on the project on your local system.

First, follow the steps in Running the project.

git checkout -b my-fix
# fix some code / add feature...

git commit -m "fix: corrected a typo"
git push origin my-fix

Lastly, open a pull request on GitHub. Once merged, your changes will automatically be deployed to the live site via the CI/CD pipeline.

Scripts

• pnpm start - build and start production server
• pnpm start:test - build and start production server in test mode.
• pnpm build - build for production. The generated files will be on the dist folder.
• pnpm build:test - build for testing. The generated files will be on the tests/dist folder.
• pnpm serve - locally start the production build.
• pnpm serve:test - locally start the testing build.
• pnpm clean - clean build directory
• pnpm commit - commit using commitizen
• pnpm dev - start a development server with hot reload.
• pnpm dev:test - start a development server with hot reload in test mode - used for running cypress tests with coverage.
• extract-translations - extract translations from source files using i18next. configuration file for this is on i18next-parser.config.js. The generated files will be on the public/locales folder.
• pnpm prepare:husky - install husky.
• pnpm lint - runs TypeScript and ESLint.
• pnpm lint:eslint - runs ESLint.
• pnpm lint:tsc - runs TypeScript.
• pnpm test - run unit tests.
• pnpm test:ci - run all unit and integration tests in CI mode.
• pnpm test:e2e - run all e2e tests with the Cypress Test Runner.
• pnpm test:e2e:headless - run all e2e tests headlessly.
• pnpm test:e2e:ci - run all e2e tests for CI Environment.
• pnpm coverage:jest - open the coverage report in the browser for jest.
• pnpm coverage:cypress - open the coverage report in the browser for cypress.
• pnpm validate - runs lint, test:ci and test:e2e:ci.