https://github.com/fairdatasociety/fairos-docs

Documentation for fairOS
https://github.com/fairdatasociety/fairos-docs

Last synced: 7 days ago
JSON representation

Documentation for fairOS

• Host: GitHub
• URL: https://github.com/fairdatasociety/fairos-docs
• Owner: fairDataSociety
• License: cc-by-4.0
• Created: 2021-02-07T12:06:33.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T16:31:23.000Z (14 days ago)
• Last Synced: 2024-11-04T17:32:51.477Z (14 days ago)
• Language: HTML
• Size: 21.6 MB
• Stars: 2
• Watchers: 5
• Forks: 4
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FairOS Documentation Website

Documentation for the [FairOS](https://github.com/fairDataSociety/fairOS-dfs). View at [https://docs.fairos.fairdatasociety.org/docs/](https://docs.fairos.fairdatasociety.org/docs/).

### Node Version

You must use **node 14** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).

### Installation

```

$ npm i

```

### Local Development

```

$ npm start

```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Build

```

$ npm run build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Bumping Version

Don't forget to find and replace the version number for the whole of the docs folder. 

## How to generate / include the API reference html

**NOTE: when this is done, the docs will have to be rebuilt.**

```

$ npm run generate

```

## License

This documentation is provided under the [Creative Commons License](https://github.com/fairDataSociety/fairOS-docs/blob/master/License-docs)