https://github.com/nexys-system/core

Nexys web framework
https://github.com/nexys-system/core

koa nexys typescript user-management

Last synced: about 2 months ago
JSON representation

Nexys web framework

• Host: GitHub
• URL: https://github.com/nexys-system/core
• Owner: nexys-system
• License: agpl-3.0
• Created: 2020-04-17T17:15:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-24T10:24:05.000Z (about 1 year ago)
• Last Synced: 2024-05-08T11:25:40.616Z (8 months ago)
• Topics: koa, nexys, typescript, user-management
• Language: TypeScript
• Homepage: https://nexys.io
• Size: 1.23 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nexys web framework

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

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

[![NPM package](https://badge.fury.io/js/%40nexys%2Fcore.svg)](https://www.npmjs.com/package/@nexys/core)

[![NPM package](https://img.shields.io/npm/v/@nexys/core.svg)](https://www.npmjs.com/package/@nexys/core)

[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)

Nexys typescript web framework (built on top of Koa and Nexys System SDK)

## Setup

### App init

see `/server` for example implementation or https://github.com/nexys-system/server-boilerplate

### Cache Initialization

path suggestion: `src/service/cache.ts`

```

import { Cache } from '@nexys/core';

export default new Cache.Local({persistent: true });

```

### Middleware Auth

path suggestion: `src/middleware/auth.ts`

```

import { Middleware} from '@nexys/core';

import * as Login from '../service/login';

import cache from '../service/cache';

// initalizes the middleware auth with

// - `Profile` defines the JWT Profile shape

// - `UserCache` defines the shape of the information saved in the userCache

// - `cache`reference to the cache

export default new Middleware.Auth(cache);

```

### Associated projects

- [Fetch-r](https://github.com/nexys-system/fetch-r)

- [Workflow](https://github.com/nexys-system/workflow)

- [Cache](https://github.com/nexys-system/node-cache-persistent)

- [API-request](https://github.com/nexys-system/api-request)

- [Validation](https://github.com/nexys-system/validation)

- [Crypto](https://github.com/nexys-system/crypto)

- [Social logins](https://github.com/nexys-system/oauth)