https://github.com/nexys-system/server-boilerplate

Server boilerplate in Typescript for nexys-system
https://github.com/nexys-system/server-boilerplate

boilerplate koa nexys node typescript

Last synced: 12 days ago
JSON representation

Server boilerplate in Typescript for nexys-system

• Host: GitHub
• URL: https://github.com/nexys-system/server-boilerplate
• Owner: nexys-system
• Created: 2020-09-19T21:54:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T15:35:14.000Z (about 2 years ago)
• Last Synced: 2024-11-24T00:25:03.856Z (2 months ago)
• Topics: boilerplate, koa, nexys, node, typescript
• Language: TypeScript
• Homepage: https://app.nexys.io
• Size: 406 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nexys Backend Typescript Boilerplate

[![Test](https://github.com/nexys-system/server-boilerplate/actions/workflows/test.yml/badge.svg)](https://github.com/nexys-system/server-boilerplate/actions/workflows/test.yml)

[![Docker](https://github.com/nexys-system/server-boilerplate/actions/workflows/publish.yml/badge.svg)](https://github.com/nexys-system/server-boilerplate/actions/workflows/publish.yml)

This repo generates a fully working node server (typescript).

It is based on [nexys/core](https://github.com/nexys-system/core) [![NPM package](https://badge.fury.io/js/%40nexys%2Fcore.svg)](https://www.npmjs.com/package/@nexys/core) and most configurations can be managed in [nexys.io](https://app.nexys.io).

## Get started

click on _use this template_, clone your repo locally and

```

# install dependencies

yarn

# watch - will run on port 3000 and reload after changes are applied

yarn watch

```

Note: that the CI Node version is set to 18.If your build fails locally try to change your node version so it matches the one used in the CI.

### Sync with Nexys.io

#### Get the Environment Variables

```

yarn getEnvVar

```

You will then be prompted for a token. You can generate the token in the nexys.io platform on top the of the env var panel (in the service of interest)

A `.env` file will be generated with the environment variables. Note that if you are using a database, you need to tick the option when configuring the service and the database env var will be added automatically.

#### Get the Assets

```

yarn getAssets

```

This will fetch the data model, the submodels, roles, option sets, api requests, and workflows.

Note: this command can only be run if you have the environment variables and an `APP-TOKEN`.

## GraphQL

You can query the database using [GraphQL](https://graphql.org/). The URLs are

* `host/graphql/query` for querying

* `host/graphql/schema` for the schema

### Graphql query examples (tested in postman)

#### Query

```

{

  Instance{name}

}

```

#### Mutation

##### Insert

```

mutation {

  insertInstance( name:"main", logDateAdded: "2022-12-12"){uuid}

}

```

##### Update 

```

mutation {

  updateInstance(data:{name: "main2"}, filters:{name: "main"}){updated}

}

```

##### Delete

```

mutation {

  deleteInstance(input:{uuid:"20074488-2467-11ed-8130-42010aac000a"}){deleted}

}

```

### Accessing the GraphQL object from within the app

```

import { graphql, printSchema } from "graphql";

import Schema from "@nexys/fetchr/dist/graphql/schema";

const query:string = ""; // graphql query

const result = await graphql({ schema: schemas.gQLSchema, source: query });

```

Don't forget to add the `APP-TOKEN` (look in your `.env` file) in the headers: `Authorization: Bearer APP-TOKEN`

## Deployment

A docker is generated upon new version creation, see https://github.com/nexys-system/server-boilerplate/releases

## CI

every push goes through CI and can be monitored [here](https://github.com/nexys-system/server-boilerplate/actions)