npm installfrom the root folder.
cd examples/mars-theme-example/to go to the example directory.
npm testfrom the root to check if the fork passes the tests.
cd e2e && npm i && node e2e.js --cypress run —prod
pushto your fork.
git clonecommand was executed.
npm installon the root folder:
npm installfrom the root of the Frontity project ("frontity" folder)
Make sure you don't run this from any of the packages folders.
npm installindividually on these example projects. The installation of dependencies in all packages of the repo (including these example projects) are handled globally by the
npm installdone from the root of
examplesfolder and, for example
mars-theme-example, and run
npx frontity dev. This will start Frontity with mars-theme on localhost:3000 and it will open automatically a new tab on your browser.
npm run build:watchto automatically execute
npm run buildevery time you save changes in the code of the packages that run before Webpack, like
babel-plugin-frontityor the scripts of
npm testfrom the root folder. This command will tell you if your code pass all the tests, or if there's some test failing.
npm teston a package to detect where is the problem.
npm run test:ciin the root to pass all tests without cache. It is useful for TypeScript tests.
e2efolder and run:
Prettierconfiguration. Please make sure you have both installed in your editor. For VS Code, the extensions are:
interfacewhen functions have object arguments.
interfacewhen functions take an object as an argument or when functions return an object
@linktag to link the interface and function together.
spaceto select a package. Hit
enterwhen all desired packages are selected.