Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 3.15 KB

README.md

File metadata and controls

71 lines (43 loc) · 3.15 KB

CRAN/E is a modern PWA (Progressive Web App) that serves as a search engine and information display for packages hosted on CRAN. CRAN/E means 'The Comprehensive R Archive Network, Enhanced' and aims at finding R-packages as fast as possible.






Applications

You can use CRAN/E directly in any modern browser. CRAN/E can also be installed as a PWA locally in Chromium-based browsers as well as the latest Safari. For more information regarding PWAs, please visit this great guide.

You can directly use the typeahead search of CRAN/E in Raycast. We published an extension on the Raycast Store to search for packages and authors. All CRAN/E Raycast extensions are developed as FOSS as well at flaming-codes/crane-raycast.



About

This repository contains all code required to build the Frontend of CRAN/E. We decided to develop it as OSS as we believe in the advantage of a strong community as well as transparency regarding our development.

CRAN/E is not a package hosting solution for R-code. It's sole purpose is to provide a simple and effective interface for finding packages hosted on CRAN.

You find the site code (frontend & main backend) in /web. The main code in /web is deployed on DigitalOcean and uses Remix to deliver the pages as well as serve endpoints to fetch their data.

Motivation

The official CRAN is in a desperate visual state. Although it's using a very simple structure and basically no potentially distracting styling, using the original site is hard for a few reasons:

  • no search interface
  • all packages in the overview get loaded at once
  • using outdated and deprecated technology, such as <frameset>

Therefore we decided to develop a new user interface with search capabilities, that's working on all screen classes using state-of-the-art APIs.



Structure

This repo uses the web-directory for the PWA codebase. The web-directory is a Remix-project and contains all necessary code to run the frontend of CRAN/E.



Contribution

We openly encourage everyone to submit bug reports and new ideas to consistently improve the overall app experience.

Feature requests

For new features you want to add, please use the Github Discussions feature of this repo. We don't blindly accept feature requests as issues. Each feature requests is discussed first, and if a consent is achieved, the progress for implementing it will be tracked via an issue.

Bug reports

For new bug reports, please create an issue in this repository. The issue setup will guide through the necessary data required for submission.



Maintainer

This code is mainly created and maintained by flaming.codes.