Usage

Node.js 14 or 16 is 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).

Starting Development Server with Hot-Reload

Run yarn start. By default it will use our staging backend candy.freefeed.net.

Alternatively, you can install freefeed-server and create config/local.json file with URL of local backend:

{
  "api": {
    "root": "http://localhost:3000"
  }
}

You can also use custom local configuration file or additional environment variables to override default settings. FreeFeed uses the config npm module to manage the configuration. Please read it documentation to learn how add custom settings.

Sanity checks

1. yarn test will build test-suite and run the tests
2. yarn lint will check if sourcecode complies to the coding guidelines

Build a production version

1. yarn build-prod will build a production version in the _dist folder

Pre-commit hooks

We 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.

License