nimbella / demo-projects Goto Github PK

The News API needs unit tests, mocking the response from the google-news-rss and sorting the results accordingly.

We've had a few asks for a typescript project. So we should add one.

In credential.js in the ocr example the options for generating a file upload for put are:

const options = {
    headers: {
      'Content-Type': 'multipart/formdata; charset=UTF-8', // wrong!
      'Access-Control-Allow-Origin': '*',
      'Cross-Domain': true
    }
  };

Actually when you do a PUT you DO NOT HAVE to use multipart form/data, just upload the file as is.
As a result, you have to do ad upload generating a put request that will upload the file as a binary string also specifying Contet-Type "multipart/formdata".... that is not.

I went crazy following the example because I tried to upload with put and multiplart/form-data that is NOT decoded by the put.

I was finally able to perform the upload removing the Content-Type when generating the file upload and then doing a plain put of the file to upload.

We welcome enhancements to existing command sets and entirely new command sets. We need to put a contribution guide and how to facilitate such contributions.

For the election project, we should rename the API secret from g_token to GOOGLE_CIVIC_API_TOKEN and use $(GOOGLE_CIVIC_API_TOKEN) in the project.yml because it makes the deploy step/instruction simpler (no .env file to create).

A .env file may still be used. The docs should describe how to use both.

The docs right now assume the project will provide its own API key. Instead, allow for a configuration for the app so that in the absence of a key, the Nimbella API is used instead.

The election demo has a lot of open dependencies. It recently entered a state where the actual dependencies that are loaded are inconsistent:

> [email protected] build .../main/config/deployable/election/web
> react-scripts build

Creating an optimized production build...
Failed to compile.

./node_modules/mobx-react-lite/es/utils/assertEnvironment.js
Attempted import error: 'makeObservable' is not exported from 'mobx'.

This breaks the Jenkins deploy job. I am separately recommending that we take the election demo out of the main build until this is fixed.

Allow page visitor to click on sate to assign the electoral votes to one of the two parties and tally up the results. This permits the user to simulate a path to victory.

We temporarily removed the voterinfo page. We should add this back.

When you first load the divisions and voter info pages there's is an invalid page load.

The OCR example which adds slack notifications should use an environment property in the project manifest instead of parameters.

This is also needed for the Printer demo.

we have several react apps but they requires api keys (trade demo), or are long builds (chat) - I suggest adding a smaller react example that is easier to understand.

The links here are hard to see when in night mode.

When entering a query in the division and voter info page, the search isn't executed until you click the magnifying glass. It should at least accept the return key being pressed or make it more clear you need to click the icon.

I suggest setting up GitHub actions to build the demos.

Originally posted by @rabbah in #47 (comment)

Several of the API functions read files into memory but do so inside main(). Instead move these to init time and remove the conditional check.

For example, exitpolls

becomes:

const contents = fs.readFileSync(__dirname + '/exitpolls.json', 'UTF-8');
const body = JSON.parse(contents)

function main(args) {
	return { body }
}

There are several functions like this:

• Resources
• Time Series
• State/Counties
• Exit Polls

There are several APIs implemented as serverless functions located in the election/packages directory:
https://github.com/nimbella/demo-projects/tree/master/election/packages/ge2020

Some of these functions make API calls to the Google civic API. Add unit tests for each API/function by mocking the API call and simulating the API response.

• Voter Info
• Representatives
• Election Data
• Divisions

Rodric suggested one based on https://towardsdatascience.com/creating-a-restful-serverless-api-with-azure-functions-and-mongodb-6221cfd51a43. Rodric says

it looks like most if not all of the code is there
client would need mongolabs account and to provide credentials with env vars

I'll get myself a mongolabs account and see if I agree that "all of the code is there" 🙂 .

using require('nim') gives deprecation message, replace it with the sdk

'nim' is deprecated. Please use '@nimbella/sdk' instead. Visit https://github.com/nimbella/nimbella-sdk-nodejs to learn more.

Currently qr-java is a package within the qrcode project.

This is not a good illustration of multi-language development because both versions do basically the same thing.

It complicates use of the project under either ecosystem because deploying the project now requires the union of the tools of the two ecosystems. For example, you can't deploy the project as a nodejs developer without having mvn installed (a more Java-centric tool). If this were motivated by a real multi-language use case it would be fine.

I suggest there should be two (top-level) projects qrcode-js and qrcode-java (or something like that).

If this is not done, then, at a minimum, because of this complication, the actual pre-requisites should be documented more clearly as such in the README since typical programmers might not have the union of both.

When navigating through the election starter APIs, there's a baseURL place holder but it's unclear what this value should be. It's not the domain name for the project deployment but the domain name + /api/ge2020/.

This will be a useful project to demonstrate how to integrated with an external identity provider.

The api token for the stock API is currently set as a parameter but is better suited for an environment variable.

The election project requires an api key for the civic API. The app should use the Nimbella API if a key is not provided so that it's easier to deploy and get started.

The documentation should be updated accordingly.

> nim project deploy github:nimbella/demo-projects/visits
Deploying project 'github:nimbella/demo-projects/visits'
  to namespace '...'
  on host '...'

Deployed 2 web content items to
...
Deployed actions ('nim action get <actionName> --url' for URL):
  - visits/counter
  - visits/info
Failures:
 ›   Error: While deploying action visits/composer: Action 'visits/composer' not deployed: runtime type could not be determined

likely because we support php 8 now and this project has no project.yml