david32145 / nodejs-reflect-metadata

An app using the reflect-metada api.

NodeJS Reflect Metada

This app is like the features of an common ORM, but only the findAll and create methods. The app uses decorations in the declarations of models .

👨🏼‍💻 Development Contact

David Nascimento

• Github
• [e-mail]

🚀 Technologies

• ts-node-dev;
• dotenv;
• typescript;
• reflect-metadat;
• knex;
• mysql;

🎌 What I've learned

• The reflect api;
• Environment vars;
• Typescript decorations;
• How doing an ORM 😅.

🎥 How Usage

With decoration you can declarate the model like this:

@Table("users")
class User extends Repository{
  @Column("id", true)
  public id!: number
  @Column("name")
  public name!: string
  @Column("email")
  public email!: string
  @Column("description")
  public description!: string

  public toJSON(): Object {
    return {
      id: this.id,
      name: this.name,
      email: this.email,
      description: this.description
    }
  }
}

User
  .findAll()
  .then(console.log)

You can be view the full example into src/index.ts .

✋🏻 Prerequisites

• Node.js
• Yarn
• SQL Database

🔥 Install and Running

1. Config you environment;
2. Git clone git clone https://github.com/david32145/nodejs-reflect-metadata ;
3. Run yarn install or npm install for install dependencies;
4. Copy .env.example to .env and fill with your config. Below an example of .env ;

DB_HOST=localhost
DB_PORT=3306
DB_NAME=reflect_matadata
DB_USER=root
DB_PASS=root

5. Run yarn migration:up or npm run migration:up for up database migrations;
6. Run yarn dev or npm run dev
7. Edit src/index.ts and start the game.