Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luox-app/luox
Code base for the luox platform
https://github.com/luox-app/luox
chronobiology iprgcs light melanopsin metrology neuroscience
Last synced: about 1 month ago
JSON representation
Code base for the luox platform
- Host: GitHub
- URL: https://github.com/luox-app/luox
- Owner: luox-app
- License: gpl-3.0
- Created: 2019-12-12T14:48:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T19:44:32.000Z (10 months ago)
- Last Synced: 2024-09-06T15:36:20.618Z (5 months ago)
- Topics: chronobiology, iprgcs, light, melanopsin, metrology, neuroscience
- Language: JavaScript
- Homepage: https://luox.app/
- Size: 14.3 MB
- Stars: 14
- Watchers: 4
- Forks: 11
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION
Awesome Lists containing this project
- awesome - luox-app/luox - Code base for the luox platform (JavaScript)
README
# luox
## Development
The app is made up of HTML, CSS and JavaScript. We're using ES2015 modules and we use [webpack](https://webpack.js.org) to bundle the application. The core of the application is pure JavaScript and the user interface uses [React](https://reactjs.org).
We use [Prettier](https://prettier.io) to ensure consistent code formatting and [ESLint](https://eslint.org) with [Airbnb's JavaScript style guide](https://github.com/airbnb/javascript) to automatically find and fix problems as well as enforcing a particular code style in our JavaScript.
### Install nvm and node
```
$ brew install nvm
$ source ~/.nvm/nvm.sh
$ # Follow instructions to configure your bash config
```
### Install node
```
$ cd /path/to/lightbox
$ nvm install
$ nvm use
Found '/path/to/lightbox/.nvmrc' with version
Now using node v10.19.0 (npm v6.13.4)
```
### Install packages
```
$ npm install
```
### Running tests
The tests are written using [Jest](https://jestjs.io).
```
$ npm test
```
### Starting app in development
```
$ npm start
```
## Deploy Preview
Netlify automatically runs a build on a non-`master` branch when a GitHub pull request is opened for that branch. If the build passes then Netlify automatically deploys the changes to a "Deploy Preview" whose URL is publicly accessible, but "secure" by being an obscure/unguessable URL. Deploy Previews are listed [here](https://app.netlify.com/sites/luox/deploys?filter=deploy+previews).
## Production
Netlify automatically runs a build when commits are pushed to the `master` branch. If the build passes then Netlify automatically deploys the changes to the production website, [luox.app](https://luox.app/). Production deployments are listed [here](https://app.netlify.com/sites/luox/deploys?filter=master).
## Note
Please note that this repository is participating in a study into sustainability of open source projects. Data will be gathered about this repository for approximately the next 12 months, starting from 4 June 2021.
Data collected will include number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed.
For more information, please visit [our informational page](https://sustainable-open-science-and-software.github.io/) or download our [participant information sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).