Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baderlab/covid19-dashboard
https://github.com/baderlab/covid19-dashboard
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/baderlab/covid19-dashboard
- Owner: BaderLab
- License: mit
- Created: 2020-03-30T19:18:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-24T22:39:36.000Z (over 4 years ago)
- Last Synced: 2024-11-05T10:26:29.061Z (about 2 months ago)
- Language: JavaScript
- Size: 14.1 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# COVID19 dashboard
## Required software
- [Node.js](https://nodejs.org/en/) ^12 for building the project
- [Chrome](https://www.google.com/chrome/) for debugging
## Getting started
- Prerequisites:
- Node.js
- Option 1: Install [nvm](https://github.com/nvm-sh/nvm) so you can have multiple versions of node installed.
- Install version 12 with `nvm install 12`.
- Set version 12 as your default: `nvm alias default 12`.
- To use a particular version, do `nvm use 12.0.1` or set up a `.nvmrc` file in the CWD and do `nvm use`.
- Option 2: Install node manually:
- Mac: `brew install node@12`
- Linux: Use `dnf`, `zypper`, `apt`, etc.
- Or use [the installer](https://nodejs.org/en/download/) for Mac or Windows
- Chrome
- [Install Chrome](https://www.google.com/chrome/)
- Become familiar with the [debug tools](https://developers.google.com/web/tools/chrome-devtools/javascript/)
- Start off by running `npm install`.
- The main target you will run during development is `npm run watch`.
- This automatically builds the clientside code in the background. The browser will refresh automatically when the code is rebuilt.
- The Chrome debugger can be used for the clientside code (Chrome > View > Developer > Developer Tools). There is also an included launch config file that allows you to debug the client or the server directly in VSC. Make sure to run `npm run watch` before opening the Chrome debugger.
## Configuration
The following environment variables can be used to configure the server:
- `NODE_ENV` : the environment mode, either `production` or `development` (default)
- `PORT` : the port on which the server runs (default 3000)
## Run targets
- `npm start` : start the server (usually for prod mode)
- `npm run watch` : watch mode (debug mode enabled, autorebuild, autoreload, server at [http://localhost:3000](http://localhost:3000))
- `npm run build` : build project
- `npm run build-prod` : build the project for production
- `npm run bundle-profile` : visualise the bundle dependencies
- `npm run clean` : clean the project
- `npm run lint` : lint the project
- `npm run test:mocha` : run model tests
- `npm test` : run model tests, linting, and a build (run this before doing a pull request)
## Running via Docker
Build the container. Here, `covid19-dashabord` is used as the container name.
```
cd covid19-dashabord
docker build -t covid19-dashabord .
```
Run the container:
```
docker run -it -p 12345:3000 -u "node" -e "NODE_ENV=production" --name "covid19-dashabord" covid19-dashabord
```
Notes:
- The `-it` switches are necessary to make `node` respond to `ctrl+c` etc. in `docker`.
- The `-p` switch indicates that port 3000 on the container is mapped to port 12345 on the host. Without this switch, the server is inaccessible.
- The `-u` switch is used so that a non-root user is used inside the container.
- The `-e` switch is used to set environment variables. Alternatively use `--env-file` to use a file with the environment variables.
- References:
- [Dockerizing a Node.js web app](https://nodejs.org/en/docs/guides/nodejs-docker-webapp/)
- [Documentation of docker-node](https://github.com/nodejs/docker-node)
- [Docker CLI docs](https://docs.docker.com/engine/reference/commandline/cli/)
## Testing
All files `/test` will be run by [Mocha](https://mochajs.org/). You can `npm run test:mocha` to run all tests, or you can run `npm run test:mocha -- -g specific-test-name` to run specific tests.
[Chai](http://chaijs.com/) is included to make the tests easier to read and write.
By running `npm test`, you will run the tests, the linting, and a test build.
## Publishing a release
1. Make sure the tests are passing: `npm test`
1. Make sure the linting is passing: `npm run lint`
1. Bump the version number with `npm version`, in accordance with [semver](http://semver.org/). The `version` command in `npm` updates both `package.json` and git tags, but note that it uses a `v` prefix on the tags (e.g. `v1.2.3`).
1. For a bug fix / patch release, run `npm version patch`.
1. For a new feature release, run `npm version minor`.
1. For a breaking API change, run `npm version major.`
1. For a specific version number (e.g. 1.2.3), run `npm version 1.2.3`.
1. Push the release: `git push origin --tags`
1. Deploy the app: `npm run deploy`