Skip to content

πŸ“š RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor.

License

Notifications You must be signed in to change notification settings

datacamp/rdocumentation-2.0

Folders and files

NameName
Last commit message
Last commit date
Aug 28, 2024
Jan 31, 2024
Dec 31, 2024
Dec 31, 2024
Sep 11, 2024
Sep 16, 2024
Feb 9, 2021
Sep 2, 2024
Jan 30, 2024
Nov 16, 2020
Sep 11, 2024
Mar 25, 2021
Sep 11, 2024
Jan 6, 2021
Sep 3, 2024
Jun 15, 2022
Feb 11, 2022
Sep 11, 2024
Sep 11, 2024
Sep 11, 2024
Dec 30, 2020
Dec 30, 2020
Feb 9, 2021
Sep 11, 2024
Sep 11, 2024

Repository files navigation

RDocumentation 2.0

Note: Please read this confluence page which explains the architecture of how RDocumentation works, and how to run the backend locally.

Available at:

https://rdocumentation.org

Internally:

https://rdocumentation.us-east-1.internal.datacamp-staging.com/

RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor.

Setup

To run locally, clone this repo and cd into the directory.

Create a .env.local file at the root of the repository. Since RDocumentation fetches data from the GitHub API, you'll need to create a GitHub personal access token (with public_repo scope) and add it as an environment variable.

GITHUB_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN

Then run the following to install dependencies and start the development server on http://localhost:3000:

nvm use
yarn
yarn dev

Contributing

We welcome all sorts of contributions, be it new features, bug fixes or documentation, we encourage you to create a new PR. To create a new PR or to report new bugs, please read how to contribute to RDocumentation.

Stack

This website was built by Nick Carchedi using Next.js, Tailwind CSS and DataCamp's own Waffles component library. We ❀️ open source.