Giter Club home page Giter Club logo

lynx's Introduction

Lynx Framework

Not yet usable, as is still in active development with major changes happening.

Built with

Bold are required components (not easy to replace)

Component Using Descrption
Base NestJS
Database TypeORM
File Upload Multer
Logger Winston
Error Reporting Sentry
Validation Class-Validator
Documentation Swagger
Configuration Dotenv
Authentication Passport.js
Testing Mocha & Chai
Code Style Airbnb & TS-Lint

Progress

  • File Upload (disk, s3, memory)
  • Authentication (JWT, OAuth)
  • Logger
  • Request Context
  • Error Reporting
  • Database Migrations
  • Database Seeding
  • Testing (e2e, unit)

Usage

Install

$ npm install

Create new file .env in project root folder using example.env as a template.

Start

Development environment:

$ npm run start

Production environment:

$ npm run build
$ node dist/src/api.ts

Initial database creation

$ npm run migrate sync

Migrations

Creating new migration named createSomeModel:

$ npm run migrate create createSomeModel

Other commands are self-explanatory:

$ npm run migrate [up|down|executed|pending|create]

E2E Testing

First run the testing server:

$ npm run start:test

Then run Mocha testing framework:

$ mocha test/*.spec.ts

Before hooks in e2e/ directory will clean test database, initialize sequelize and seed fake data.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.