trond-snekvik / ncs-app-index

An index of independent application repositories built with the nRF Connect SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nRF Connect SDK App Index

An index of applications built for the nRF Connect SDK.

Contributing

If you or your organization has a project that you'd like to include in the nRF Connect SDK App Index, you can open a pull request against this repository. See the details shown in the CONTRIBUTING file for more information.

Development

To build the index file, run npm run generate-index-json from the root directory.

Website

This repository includes a static website that displays the contributed applications in a searchable frontend. It's developed using the Next.js React framework, and uses Tailwind for styling.

To launch a live server development server, run npm run dev inside the site directory. By default, the site runs on port 4000, but this can be overridden by setting the PORT environment variable.

Application data is read at build time. For development purposes, sample data can be imported from sampleData.ts.

Building

To build the website, run the following commands:

  1. In the root directory, run npm install
  2. In the site directory, run npm run build

This will create an optimised static build in the /site/out directory.

Schemas

JSON schemas are provided to enforce the shape of the data in the index. They are located in the resources directory. To edit the schemas, make any changes in site/src/schema.ts and run npm run generate-schemas from the root directory.

About

An index of independent application repositories built with the nRF Connect SDK


Languages

Language:TypeScript 94.3%Language:CSS 4.0%Language:JavaScript 1.6%