Node.js versions 16, 18, 20 are supported.
We use yarn as dependency manager (instead of npm) so you need to install it and run yarn
after downloading this code. If you're using Windows, you should install developer tools by using npm install --global --production windows-build-tools
from an elevated PowerShell or CMD.exe (run as Administrator).
Run yarn start
. By default it will use our staging backend candy.freefeed.net.
Alternatively, you can install freefeed-server and create config.json
file with URL of local backend:
{
"api": {
"root": "http://localhost:3000"
}
}
You can also override any other configuration values. See config/README.md for details.
yarn test
will build test-suite and run the testsyarn lint
will check if source code complies to the coding guidelinesyarn build-prod
will build a production version in the _dist
folderWe use pre-commit hook which fixes code-style. In case you want to disable it (because your IDE does this already, for
example) you can create an empty .no_husky
file in the root directory of project.