Getting started

Install the latest version of Faroe:

You can immediately start the server on port 4000 with faroe server:

./faroe serve

./faroe serve --port=3000

This will create a faroe_data folder in the root that contains the SQLite database. Remember to add this to .gitignore.

For production apps, generate a secret with the generate-secret command and pass it when starting the sever.

./faroe generate-secret

./faroe serve --secret=SECRET

You can get a formatted list of users by sending a GET request to /users with the Accept header set to text/plain.

curl http://localhost:4000/users -H "Accept: text/plain"