Table of Contents
Please visit our project in Crowdin to translate Nigthscout. If you want to add a new language, please get in touch with the dev team in Discord.
Nightscout is a Node.js application. The basic installation of the software for local purposes is:
- Clone the software to your local machine using git
- Install Node from https://nodejs.org/en/download/
- Use
npmto install Nightscout dependencies by invokingnpm installin the project directory. Note the dependency installation has to be done using a non-root user - do not use root for development and hosting the software! - Get a Mongo database by either installing Mongo locally, or get a free cloud account from mLab or MongoDB Atlas.
- Configure Nightscout by copying
docs/example-template.envtomy.envand run it - see the next chapter in the instructions
We develop on the dev branch. All new pull requests should be targeted to dev. The master branch is only used for distributing the latest version of the tested sources.
You can get the dev branch checked out using git checkout dev.
Once checked out, install the dependencies using npm install, then copy the included docs/example-template.env to my.env file to my.env and edit the file to include your settings (like the Mongo URL). Leave the NODE_ENV=development line intact. Once set, run the site using npm run dev. This will start Nightscout in the development mode, with different code packaging rules and automatic restarting of the server using nodemon, when you save changed files on disk. The client also hot-reloads new code in, but it's recommended to reload the website after changes due to the way the plugin sandbox works.
Note the template sets INSECURE_USE_HTTP to true to enable the site to work over HTTP in local development.
If you want to additionaly test the site in production mode, create a file called my.prod.env that's a copy of the dev file but with NODE_ENV=production and start the site using npm run prod.
Nightscout implements a REST API for data syncronization. The API is documented using Swagger. To access the documentation for the API, run Nightscout locally and load the documentation from /api-docs (or read the associated swagger.json and swagger.yaml files locally).
Note all dates used to access the API and dates stored in the objects are expected to comply with the ISO-8601 format and be deserializable by the Javascript Date class. Of note here is the dates can contain a plus sign which has a special meaning in URL encoding, so when issuing requests that place dates to the URL, take special care to ensure the data is properly URL encoded.
If you intend to add a new feature, please allow the community to participate in the design process by creating an issue to discuss your design. For new features, the issue should describe what use cases the new feature intends to solve, or which existing use cases are being improved.
Note Nightscout has a plugin architecture for adding new features. We expect most code for new features live inside a Plugin, so the code retains a clear separation of concerns. If the Plugin API doesn't implement all features you need to implement your feature, please discuss with us on adding those features to the API. Note new features should under almost no circumstances require changes to the existing plugins.
Some simple rules that will make it easier to maintain our codebase:
-
All indenting should use 2 space where possible (js, css, html, etc).
-
Include a space before function parameters, such as:
function boom (name, callback) { }, this makes searching for function calls easier. -
Name your callback functions, such as
boom('the name', function afterBoom ( result ) { }. -
Don't include author names in the header of your files, if you need to give credit to someone else do it in the commit comment.
-
Use single quotes.
-
Use the comma first style, for example:
var data = { value: 'the value' , detail: 'the details...' , time: Date.now() };
If in doubt, format your code with js-beautify --indent-size 2 --comma-first --keep-array-indentation
Fork cgm-remote-monitor and create a branch. You can create a branch using git checkout -b wip/add-my-widget. This creates a new branch called wip/add-my-widget. The "wip" stands for work-in-progress and is a common prefix so that we know what to expect when reviewing many branches.
When you are done working with your prototype, it can be tempting to post on popular channels such as Facebook. We encourage contributors to submit their code for review, debate, and release before announcing features on social media.
This can be done by checking your code git commit -avm 'my improvements are here', the branch you created back to your own fork. This will probably look something like git push -u origin wip/add-my-widget.
Now that the commits are available on github, you can click on the compare buttons on your fork to create a pull request. Make sure to select Nightscout's dev branch.
We assume all new Pull Requests are at least smoke tested by the author and all code in the PR actually works. Please include a description of what the features do and rationalize why the changes are needed.
If you add any new NPM module dependencies, you have to rationalize why they are needed - we prefer pull requests that reduce dependencies, not add them. Before releasing a a new version, we check with npm audit if our dependencies don't have known security issues.
When adding new features that add configuration options, please ensure the README document is amended with information on the new configuration.
If you've fixed a bug, please consider adding a unit test to the /tests folder that reproduces the original bug without the change.
Try to identify the root cause of the issue and fix the issue. Pull requests that simply add null checks to hide issues are unlikely to be accepted.
This can be done by committing your code git commit -avm 'my improvements are here', and pushing it to the branch you created on your own
fork. This will probably look something like
git push -u origin wip/add-my-widget.
Please include instructions how to test the changes.
We encourage liberal use of the comments, including images where appropriate.
We primarily use GitHub's ticketing system for discussing PRs and bugs, and Discord for general development chatter.
We use git-flow, with master as our production, stable branch, and dev is used to queue up for upcoming releases. Everything else is done on branches, hopefully with names that indicate what to expect.
Once dev has been reviewed and people feel it's time to release, we follow the git-flow release process, which creates a new tag and bumps the version correctly. See sem-ver for versioning strategy.
Every commit is tested by travis. We encourage adding tests to validate your design. We encourage discussing your use cases to help everyone get a better understanding of your design.
- Join the Discord chat.
- Get a local dev environment setup if you haven't already.
- Try breaking up big features/improvements into small parts. It's much easier to accept small PR's.
- Create tests for your new code as well as the old code. We are aiming for a full test coverage.
- If you're going to be working in old code that needs lots of reformatting, consider doing it as a separate PR.
- If you can find others to help test your PR, it will help get them merged in sooner.
We welcome new contributors. We do not only need core contributors. Regular or one time contributors are welcomed as well. Also if you can't code, it's possible to contribute by improving the documentation or by translating Nightscout in your own language
| Contribution area | List of contributors |
|---|---|
| Core developers: | @jasoncalabrese @MilosKozak @PieterGit @sulkaharo |
| Former Core developers: (not active): | @bewest |
| Contributing developers: | @jpcunningh @scottleibrand @komarserjio @jweismann |
| Issue/Pull request coordination: | Please volunteer |
| Cleaning up git fork spam: | Please volunteer |
| Documentation writers: | @andrew-warrington @unsoluble @tynbendad @danamlewis @rarneson |
| Contribution area | List of developers | List of testers |
|---|---|---|
alexa (Amazon Alexa) |
[@inventor96] | Please volunteer |
ar2 (AR2 Forecasting) |
Please volunteer | Please volunteer |
basal (Basal Profile) |
Please volunteer | Please volunteer |
boluscalc (Bolus Wizard) |
Please volunteer | Please volunteer |
bridge (Share2Nightscout bridge) |
Please volunteer | Please volunteer |
bwp (Bolus Wizard Preview) |
Please volunteer | Please volunteer |
cage (Cannula Age) |
@jpcunningh | Please volunteer |
careportal (Careportal) |
Please volunteer | Please volunteer |
cob (Carbs-on-Board) |
Please volunteer | Please volunteer |
cors (CORS) |
Please volunteer | Please volunteer |
delta (BG Delta) |
Please volunteer | Please volunteer |
devicestatus (Device Status) |
Please volunteer | Please volunteer |
direction (BG Direction) |
Please volunteer | Please volunteer |
errorcodes (CGM Error Codes) |
Please volunteer | Please volunteer |
food (Custom Foods) |
Please volunteer | Please volunteer |
googlehome (Google Home/DialogFlow) |
@mdomox @rickfriele [@inventor96] | @mcdafydd @oteroos @jamieowendexcom |
iage (Insulin Age) |
Please volunteer | Please volunteer |
iob (Insulin-on-Board) |
Please volunteer | Please volunteer |
loop (Loop) |
Please volunteer | Please volunteer |
mmconnect (MiniMed Connect bridge) |
Please volunteer | Please volunteer |
openaps (OpenAPS) |
Please volunteer | Please volunteer |
profile (Treatment Profile) |
Please volunteer | Please volunteer |
pump (Pump Monitoring) |
Please volunteer | Please volunteer |
rawbg (Raw BG) |
@jpcunningh | Please volunteer |
sage (Sensor Age) |
@jpcunningh | Please volunteer |
simplealarms (Simple BG Alarms) |
Please volunteer | Please volunteer |
speech (Speech) |
@sulkaharo | Please volunteer |
timeago (Time Ago) |
Please volunteer | Please volunteer |
treatmentnotify (Treatment Notifications) |
Please volunteer | Please volunteer |
upbat (Uploader Battery) |
@jpcunningh | Please volunteer |
xdrip-js (xDrip-js) |
@jpcunningh | Please volunteer |
| Contribution area | List of contributors |
|---|---|
| All active developers: | @jasoncalabrese @jpcunningh @jweismann @komarserjio @mdomox @MilosKozak @PieterGit @rickfriele @sulkaharo @unsoluble |
| All active testers/documentors: | @danamlewis @jamieowendexcom @mcdafydd @oteroos @rarneson @tynbendad @unsoluble |
| All active translators: | @apanasef @jizhongwen @viderehh @herzogmedia @LuminaryXion @OpossumGit |