The web application running rdocumentation.org.
JavaScript CSS HTML Other
Latest commit cfe1e38 Aug 1, 2018
Permalink
Failed to load latest commit information.
.circleci Cleanup (#402) Apr 11, 2018
.ebextensions force https Sep 21, 2016
api fixup worker Jul 18, 2018
assets Add semicolon Aug 1, 2018
config fixup worker Jul 18, 2018
jake fixup worker Jul 18, 2018
migrations add ParsingJobs and some refactoring Aug 14, 2017
proxy/conf.d fix cors Oct 19, 2016
tasks Cleanup (#402) Apr 11, 2018
test add chai and test Feb 7, 2017
views Move lead form JavaScript to a JS file Jul 27, 2018
.dockerignore dockerfile for dockerhub.datacamp Jun 29, 2016
.editorconfig init sails project May 25, 2016
.env.sample Cleanup (#402) Apr 11, 2018
.eslintrc Cleanup (#402) Apr 11, 2018
.gitignore reverse proxy Jun 30, 2016
.sailsrc disable socket io Jun 14, 2016
CONTRIBUTING.md fix minor typo Sep 15, 2017
Dockerfile Cleanup (#402) Apr 11, 2018
Dockerrun.aws.json.in Revert "open debug port" May 26, 2017
Gruntfile.js init sails project May 25, 2016
LICENSE.md add License Jun 20, 2016
Procfile use method in cronservice and cleanup Aug 8, 2017
README.md improve readme Apr 11, 2018
apidoc.json fix apidoc url Aug 25, 2016
app.js disable newrelic May 31, 2017
build.sh clean up/linting/potential leaks Feb 3, 2017
cron.yaml update worker to update percentile Oct 27, 2016
database.json Cleanup (#402) Apr 11, 2018
deploy_worker.sh clean up/linting/potential leaks Feb 3, 2017
docker-compose.yml Cleanup (#402) Apr 11, 2018
ecs.json Cleanup (#402) Apr 11, 2018
ecs.worker.json increase memory for worker Jul 23, 2018
newrelic.js Distinguish new relic app for staging and prod Jun 28, 2016
package-lock.json fixup worker Jul 18, 2018
package.json fixup worker Jul 18, 2018

README.md

rdocumentation_site_banner

rdocumentation.org provides the R community with centralized, quality and easy to search documentation.

R documentation sifts through all CRAN, GitHub and BioConductor packages hourly, parses the documentation files and indexes them in an Elasticsearch database. This makes rdocumentation.org the best online resource to browse all R package documentation.

The RDocs project is completely open-source. This repository contains the source code for the NodeJS web application that serves www.rdocumentation.org. For other codebases, you can check out CONTRIBUTING.md.

Features

  • Quick search through all packages and functions

screen shot 2016-08-25 at 14 07 05

  • Complete search through all packages and function

screen shot 2016-08-25 at 14 08 52

  • Easily assess package quality

screen shot 2016-08-25 at 14 11 27

  • Post community examples to help the community understand how to use a function

screen shot 2016-08-25 at 14 14 37

What this app does

This application is part the rdocumentation project. This app is responsible for storing the RDocumentation data, and bring it to the users through a web interface (the rdocumentation.org site) or through an api (See https://www.rdocumentation.org/docs/ for the public API)

Documentation

Documentation of the differents endpoints can be found here: http://www.rdocumentation.org/docs/

Issue/Feature request

Please post a new issue at https://github.com/datacamp/rdocumentation-app/issues for any bug that you encounter or a feature that you would like to see in rdocumetation.org.

Development

Using docker

You'll need docker and docker-compose to run this stack locally

  • Copy the .env.sample to .env and change relevant variables
  • docker-compose create to create the redis and mysql container
  • docker-compose start to fire up a local redis an mysql
  • Run the database migrations by doing npm run migrate
  • npm run start-dev

How to deploy

  • To deploy to stating (rdocumentation.datacamp-staging.com), merge to master
  • To deploy to production, add a tag which starts with release-

The rdocumentation app is hosted on DataCamp's infrastructure, on our AWS ECS cluster.

What the CI does

This application runs on the DataCamp infrastructure. Our custom CI flow will:

  • Build a docker image
  • Upload it the ECR
  • Deploy the new version to ECS

How to contribute

We welcome any contributions that could improves rdocumentation.org. There is multiple ways of contributing:

  • Report when some packages are missing/outdated/incorrect by creating an issue.
  • Report bugs.
  • Help us improves by proposing features.
  • Directly contribute by forking the repo and making changes.

License

See the LICENSE file for license rights and limitations (MIT).