Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/glin/neostocks

Real-time stock tracker for the Neopets Stock Market
https://github.com/glin/neostocks

neopets r shiny vue

Last synced: 3 months ago
JSON representation

Real-time stock tracker for the Neopets Stock Market

Awesome Lists containing this project

README

        

# neostocks

[![Build Status](https://github.com/glin/neostocks/workflows/build/badge.svg)](https://github.com/glin/neostocks/actions)
[![codecov](https://codecov.io/gh/glin/neostocks/branch/master/graph/badge.svg)](https://codecov.io/gh/glin/neostocks)

[neostocks](https://neostocks.info) is a real-time dashboard for the Neopets Stock Market, similar to the former NeoDaq.com (RIP).

## Getting Started

### Prerequisites
- [R](https://www.r-project.org/) >= 3.1
- [Node.js](https://nodejs.org) LTS or later

### Installation
Clone the repo:
```sh
git clone https://github.com/glin/neostocks
cd neostocks/
```

Install the R package:
```r
# install.packages("devtools")
devtools::install()
```

Build the UI:
```sh
npm install
npm run build
```

### Running
```r
shiny::runApp()
```

To use custom stock data, set the `NEOSTOCKS_DATA_FILE` environment variable:

```sh
# .Renviron
NEOSTOCKS_DATA_FILE=/path/to/neostocks.csv
```

## Development
Build the UI for development:
```sh
npm run dev
npm run dev:watch # rebuild on changes
```

Run UI tests:
```sh
npm test
npm run test:cover # with coverage
npm run test:watch # rerun on changes
```

Run R tests:
```r
devtools::test()
```

## License
MIT