Skip to content

Commit

Permalink
feat: move to NordicSemiconductor organization
Browse files Browse the repository at this point in the history
BREAKING CHANGE: this renames the package
See bifravst/bifravst#56
  • Loading branch information
coderbyheart committed Feb 4, 2021
1 parent 9e2622c commit 5828cf5
Show file tree
Hide file tree
Showing 84 changed files with 247 additions and 1,498 deletions.
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"extends": "@bifravst/eslint-config-typescript"
"extends": "@nordicsemiconductor/eslint-config-asset-tracker-cloud-typescript"
}
2 changes: 1 addition & 1 deletion .github/workflows/check-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ jobs:
- uses: actions/upload-artifact@v2
with:
name: bifravst-docs-${{ github.sha }}
name: asset-tracker-docs-${{ github.sha }}
path: build/html/
8 changes: 4 additions & 4 deletions .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ pull_request_rules:
- name: Automatic merge security PRs when all status checks pass
conditions:
- author~=^(snyk-bot|dependabot\[bot\])$
- status-success=security/snyk (Bifravst)
- status-success=security/snyk (Asset Tracker Cloud)
- status-success=tests
actions:
merge:
method: rebase
rebase_fallback: squash
bot_account: bifravst-ci
bot_account: asset-tracker-cloud-ci
label:
add:
- mergify
- mergify
rebase:
bot_account: bifravst-ci
bot_account: asset-tracker-cloud-ci
2 changes: 1 addition & 1 deletion .prettierrc.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = {
...require('@bifravst/code-style/.prettierrc'),
...require('@nordicsemiconductor/asset-tracker-cloud-code-style/.prettierrc'),
}
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Examples of representing our community include using an official e-mail address,
Enforcement
***********

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `bifravst@gmail.com <mailto:bifravst+codeofconduct@gmail.com?subject=Code+of+Conduct>`_. All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `markus.tacker@nordicsemi.no <mailto:markus.tacker@nordicsemi.no?subject=Asset+Tracker+Example+Code+of+Conduct>`_. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

Expand Down
62 changes: 27 additions & 35 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
.. _bifra_readme:

Bifravst
########
Asset Tracker Example
#####################


.. epigraph::

*Gvðín gerþu bru af iorþu til himins, er heitir Bifravst.*
Bifravst is a term from the Nordic mythology and it refers to the bridge built by the gods between earth and heaven.
`Read more about it <https://www.lyngen.com/2020/03/the-vikings-and-the-northern-lights-bridge/>`_.


.. image:: https://github.com/bifravst/bifravst/workflows/Test%20and%20Release/badge.svg
.. image:: https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/workflows/Test%20and%20Release/badge.svg
:alt: GitHub Actions
:target: https://github.com/bifravst/bifravst/actions
.. image:: https://snyk.io/test/github/bifravst/bifravst/badge.svg
:target: https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/actions
.. image:: https://snyk.io/test/github/NordicSemiconductor/asset-tracker-cloud-docs/badge.svg
:alt: Known Vulnerabilities
:target: https://snyk.io/test/github/bifravst/bifravst
:target: https://snyk.io/test/github/NordicSemiconductor/asset-tracker-cloud-docs
.. image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: semantic-release
:target: https://github.com/semantic-release/semantic-release
.. image:: https://img.shields.io/badge/renovate-enabled-brightgreen.svg
:alt: Renovate
:target: https://renovatebot.com
.. image:: https://img.shields.io/endpoint.svg?url=https://dashboard.mergify.io/badges/bifravst/bifravst&style=flat
.. image:: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/NordicSemiconductor/asset-tracker-cloud-docs
:alt: Mergify Status
:target: https://mergify.io
.. image:: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
Expand All @@ -39,13 +32,13 @@ Bifravst
Vision
******

*Bifravst* aims to provide a concrete end-to-end example for an ultra-low power cellular IoT product in the asset tracker space, namely a *Cat Tracker*.
The *Asset Tracker Example* aims to provide a concrete end-to-end example for an ultra-low power cellular IoT product in the asset tracker space, namely a *Cat Tracker*.

.. figure:: ./docs/logo-with-text.png
:alt: Bifravst: Cat Tracker IoT example
:alt: Asset Tracker Example: Cat Tracker IoT example

*Bifravst* enables the developers to set up a real world IoT solution using the respective cloud provider and adapt the example firmware and software quickly for a specific use case.
*Bifravst* aims to provide answers and recommend best practices to the following questions:
The *Asset Tracker Example* enables the developers to set up a real world IoT solution using the respective cloud provider and adapt the example firmware and software quickly for a specific use case.
The *Asset Tracker Example* aims to provide answers and recommend best practices to the following questions:

* How can you connect Nordic's cellular IoT chips to your cloud provider?
* How do devices send data into the cloud?*
Expand All @@ -57,34 +50,34 @@ Vision
.. note ::
In the coming weeks, we will establish the best path to provide this project through nRF Connect SDK, Nordic Semiconductor Infocenter and other established channels.
For more information, see the `GitHub issue <https://github.com/bifravst/bifravst/issues/56>`_.
For more information, see the `GitHub issue <https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/issues/56>`_.
Core principles
***************

*Bifravst* is built on the following principles:
The *Asset Tracker Example* is built on the following principles:

* *Teach by showing*

* All examples are designed to solve a concrete use case (a *Cat Tracker*) instead of providing generic or abstract solutions.
* *Bifravst* is not a framework, but it is a real application.
* The *Asset Tracker Example* is not a framework, but it is a real application.

* *Err on the side of security*

* *Bifravst* follows the most robust security recommendations of the respective cloud provider.
* The *Asset Tracker Example* follows the most robust security recommendations of the respective cloud provider.

* *Single tenancy*

* *Bifravst* implements a scenario in which all the authenticated users can be trusted to access all the devices.
* The *Asset Tracker Example* implements a scenario in which all the authenticated users can be trusted to access all the devices.
* It is a typical scenario for cellular IoT products, and it simplifies the onboarding of new devices.

* *Serverless*

* *Bifravst* uses a serverless architecture as much as possible to have near-zero costs for the operation during the development, and to provide horizontal scaling of resources to be used in a production system if needed.
* The *Asset Tracker Example* uses a serverless architecture as much as possible to have near-zero costs for the operation during the development, and to provide horizontal scaling of resources to be used in a production system if needed.

* *Cloud native*

* *Bifravst* examples are designed by following the best practices of the respective cloud provider to reduce development efforts due to abstraction.
* The *Asset Tracker Example* examples are designed by following the best practices of the respective cloud provider to reduce development efforts due to abstraction.

* *Being offline is not an exception*

Expand All @@ -97,18 +90,18 @@ Core principles

.. note::

*Bifravst* is not a *multi-cloud* solution.
The *Asset Tracker Example* is not a *multi-cloud* solution.
The concrete implementation will differ for each cloud provider.

*Bifravst* does not aim to provide a solution where you can switch in a seamingless manner between cloud providers.
The *Asset Tracker Example* does not aim to provide a solution where you can switch in a seamingless manner between cloud providers.
Such a solution will require the implementation of additional abstraction layers, which instead of becoming a meaningful benefit for the majority of users, mandate a constant translation between the vendor specific concepts and the abstraction.
Instead, in Bifravst, the best practices of the respective cloud-vendor for building a *serverless* IoT solution are followed.
Instead, in the *Asset Tracker Example*, the best practices of the respective cloud-vendor for building a *serverless* IoT solution are followed.

Project overview
****************

*Bifravst* is licensed under the `3-clause BSD license <./LICENSE>`_ (software) and the `Nordic 5-clause BSD license <https://github.com/bifravst/firmware/blob/saga/LICENSE>`_ (firmware).
Below table shows the characteristics of *Bifravst* project:
The *Asset Tracker Example* is licensed under the `3-clause BSD license <./LICENSE>`_ (software) and the `Nordic 5-clause BSD license <https://github.com/nrfconnect/sdk-nrf/blob/master/LICENSE>`_ (firmware).
Below table shows the characteristics of the *Asset Tracker Example* project:

+------------------------------------+----------------------+
| Characteristic | Principle |
Expand Down Expand Up @@ -136,7 +129,7 @@ Below table shows the characteristics of *Bifravst* project:

.. note::

Development progress is managed in the `Bifravst GitHub Project <https://github.com/orgs/bifravst/projects/1>`_.
Development progress is managed in the `The Asset Tracker Example Development GitHub Project <https://github.com/orgs/NordicSemiconductor/projects/2>`_.

System overview and technical considerations
********************************************
Expand Down Expand Up @@ -196,7 +189,7 @@ See the below table for a list of supported cloud providers:
+-------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------------------+---------------+
| | Amazon Web Services | Google Cloud | Microsoft Azure | Alibaba Cloud |
+===================+===========================================================================================+=============================================================+=================================================================+===============+
| LTE-M: TCP+MQTT | :ref:`feature complete <aws-getting-started>` | `on hold <https://github.com/bifravst/bifravst/issues/25>`_ | `in progress <https://github.com/bifravst/bifravst/issues/29>`_ | Planned |
| LTE-M: TCP+MQTT | :ref:`feature complete <aws-getting-started>` | `on hold <https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/issues/25>`_ | `in progress <https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/issues/29>`_ | Planned |
+-------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------------------+---------------+
| NB-IoT: UDP+LWM2M | Planned | Planned | Planned | Planned |
+-------------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------+-----------------------------------------------------------------+---------------+
Expand Down Expand Up @@ -229,7 +222,6 @@ Below table shows the IoT Cloud vendor survey results:
:caption: Documentation

docs/aws/Index.rst
docs/azure/Index.rst
docs/app/Index.rst
docs/firmware/Index.rst
docs/devices/Index.rst
Expand All @@ -249,8 +241,8 @@ Below table shows the IoT Cloud vendor survey results:
:titlesonly:
:caption: Resources

GitHub <https://github.com/bifravst>
DevZone <https://devzone.nordicsemi.com/search?q=bifravst#serpsort=date%20desc>
GitHub <https://github.com/NordicSemiconductor/asset-tracker-cloud-docs>
DevZone <https://devzone.nordicsemi.com/search?q=AssetTrackerExample#serpsort=date%20desc>
docs/Support.rst
docs/adr/README.rst
CODE_OF_CONDUCT.rst
Expand Down
6 changes: 3 additions & 3 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

# -- Project information ---------------------------------------------------------------------------------------------

project = 'Bifravst'
project = 'Asset Tracker Example'
copyright = '2019-2021, Nordic Semiconductor ASA | nordicsemi.no'
author = 'Nordic Semiconductor ASA | nordicsemi.no'

Expand Down Expand Up @@ -53,8 +53,8 @@
# Enable the "Edit in GitHub link within the header of each page.
html_context = {
'display_github': True,
'github_user': 'bifravst',
'github_repo': 'bifravst',
'github_user': 'NordicSemiconductor',
'github_repo': 'asset-tracker-cloud-docs',
'github_version': 'saga/'
}

Expand Down
4 changes: 2 additions & 2 deletions docs/Support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Support

.. image:: https://img.shields.io/badge/%7BDevZone-community-brightgreen.svg
:alt: {DevZone Community
:target: https://devzone.nordicsemi.com/search?q=bifravst
:target: https://devzone.nordicsemi.com/search?q=AssetTrackerExample

❓ You can get in touch via `DevZone <https://devzone.nordicsemi.com/>`_ (You can use the tag `Bifravst <https://devzone.nordicsemi.com/search?q=bifravst>`_ to mark your questions) or by `creating an issue in the Bifravst repository <https://github.com/bifravst/bifravst/issues/new>`_.
❓ You can get in touch via `DevZone <https://devzone.nordicsemi.com/>`_ (You can use the tag `AssetTrackerExample <https://devzone.nordicsemi.com/search?q=AssetTrackerExample>`_ to mark your questions) or by `creating a new post in the the Asset Tracker Example Discussions <https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/discussions/new>`_.
2 changes: 1 addition & 1 deletion docs/adr/002-use-npm-package-registry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

In March 2020, `GitHub acquired NPM <https://github.blog/2020-03-16-npm-is-joining-github/>`_ and will keep it operational as a registry for public JavaScript packages, so as of now packages can be moved back to NPM.

This supersedes `ADR 001: Use GitHub package registry <https://github.com/bifravst/bifravst/blob/d14e0e0ec692bea5e3b1ea0b50b359c0dc8c0c4f/docs/adr/001-use-github-package-registry.md>`_.
This supersedes `ADR 001: Use GitHub package registry <https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/blob/d14e0e0ec692bea5e3b1ea0b50b359c0dc8c0c4f/docs/adr/001-use-github-package-registry.md>`_.
20 changes: 10 additions & 10 deletions docs/app/AWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Configure the IDs of your AWS resources
=======================================

The web application requires the IDs of the AWS resources that were created during the setup of the stack.
Run the following command in the :file:`bifravst-app` directory to copy the output that contain the IDs to the :file:`.env.local` file:
Run the following command in the :file:`asset-tracker-app` directory to copy the output that contain the IDs to the :file:`.env.local` file:

.. code-block:: bash
node ../bifravst-aws/cli react-config > .env.local
node ../asset-tracker-aws/cli react-config > .env.local
Example for :file:`.env.local`
------------------------------
Expand All @@ -39,19 +39,19 @@ Following is an example for the contents of the :file:`.env.local` file:
REACT_APP_REGION=eu-west-1
REACT_APP_HISTORICALDATA_TABLE_INFO=historicalDatadb40B23029-Qzk2Jrr88tOy|historicalDatatableD9D795E1-zdSByjtTqoAE
REACT_APP_USER_IOT_POLICY_ARN=arn:aws:iot:eu-west-1:249963682018:policy/bifravst-userIotPolicy-OMYBF5CI5Q6A
REACT_APP_DFU_BUCKET_NAME=bifravst-dfustoragebucket2cc839ff-qz8k9bslldrf
REACT_APP_JITP_ROLE_ARN=arn:aws:iam::249963682018:role/bifravst-iotJitpRole7B509A5D-5Y6BQY6KD9TX
REACT_APP_THING_GROUP_NAME=bifravstThings
REACT_APP_AVATAR_BUCKET_NAME=bifravst-avatarsbucket8221a59f-1usxf1qi1qj1r
REACT_APP_USER_IOT_POLICY_ARN=arn:aws:iot:eu-west-1:249963682018:policy/asset-tracker-userIotPolicy-OMYBF5CI5Q6A
REACT_APP_DFU_BUCKET_NAME=asset-tracker-dfustoragebucket2cc839ff-qz8k9bslldrf
REACT_APP_JITP_ROLE_ARN=arn:aws:iam::249963682018:role/asset-tracker-iotJitpRole7B509A5D-5Y6BQY6KD9TX
REACT_APP_THING_GROUP_NAME=assetTrackerThings
REACT_APP_AVATAR_BUCKET_NAME=asset-tracker-avatarsbucket8221a59f-1usxf1qi1qj1r
REACT_APP_USER_POOL_CLIENT_ID=1rh4eacmu5c5ppq2pspnq8tcu5
REACT_APP_MQTT_ENDPOINT=a3g4yd69u8cu7b-ats.iot.eu-west-1.amazonaws.com
REACT_APP_DEVELOPER_PROVIDER_NAME=developerAuthenticated
REACT_APP_THING_POLICY_ARN=arn:aws:iot:eu-west-1:249963682018:policy/bifravst-thingPolicy-1GR1TP3RXOO0G
REACT_APP_THING_POLICY_ARN=arn:aws:iot:eu-west-1:249963682018:policy/asset-tracker-thingPolicy-1GR1TP3RXOO0G
REACT_APP_USER_POOL_ID=eu-west-1_FiY6h4xjd
REACT_APP_IDENTITY_POOL_ID=eu-west-1:52cc8188-ec90-47d7-b3ee-634187fa6413
REACT_APP_WEB_APP_DOMAIN_NAME=d250wnpv81c7q9.cloudfront.net
REACT_APP_WEB_APP_BUCKET_NAME=bifravst-webapps-webapphostingbucketc58d3c2b-1or3is1vmmq5q
REACT_APP_WEB_APP_BUCKET_NAME=asset-tracker-webapps-webapphostingbucketc58d3c2b-1or3is1vmmq5q
REACT_APP_CLOUDFRONT_DISTRIBUTION_ID_WEB_APP=EGNO6F61DSJ5Y
REACT_APP_VERSION=v3.6.1
Expand All @@ -65,7 +65,7 @@ Version string
Deploy the web application
**************************

To build and deploy the web application to the S3 bucket created while setting up *Bifravst* in your AWS account, run the following commands:
To build and deploy the web application to the S3 bucket created while setting up the *Asset Tracker Example* in your AWS account, run the following commands:

.. code-block:: bash
Expand Down

0 comments on commit 5828cf5

Please sign in to comment.