Dinero.js Documentation site

This is where the documentation site of Dinero.js lives. It uses Nuxt.js.

Install

The content of this site runs on a separate API. Both projects need to run on the same environment for the site to work properly.

Before running the site, go to the docs repository, then install and start the docs API. It should run on http://localhost:4000.

Clone this site on your environment:

git clone https://github.com/dinerojs/dinerojs.com.git

Go to the project’s root and install the dependencies using Yarn (recommended) or npm:

yarn install
# or
npm install

Start the dev server on port 3000 by running:

yarn dev
# or
npm run dev

Then, access the site on http://localhost:3000 🚀

To render the site as static files, make sure the documentation API is running on port 4000, and then run:

yarn generate
# or
npm run generate

This should generate the site in the /dist directory.