|
1 | | -# Awesome Project Build with TypeORM |
2 | | - |
3 | | -Steps to run this project: |
| 1 | +TypeORM Documentation Website |
| 2 | +============================= |
4 | 3 |
|
5 | | -1. Run `npm i` command |
6 | | -2. Setup database settings inside `ormconfig.json` file |
7 | | -3. Run `npm start` command |
| 4 | +Documention : [https://typeorm.io/](https://typeorm.io/) |
| 5 | + |
| 6 | +Project Repo : [https://github.com/typeorm/typeorm](https://github.com/typeorm/typeorm) |
| 7 | + |
| 8 | +## What is TypeORM? |
| 9 | + |
| 10 | +TypeORM is an [ORM](https://en.wikipedia.org/wiki/Object-relational_mapping) |
| 11 | +that can run in NodeJS, Browser, Cordova, PhoneGap and Ionic platforms |
| 12 | +and can be used with TypeScript and JavaScript (ES5, ES6, ES7). |
| 13 | +Its goal to always support latest JavaScript features and provide features |
| 14 | +that help you to develop any kind of applications that use databases - from |
| 15 | +small applications with a few tables to large scale enterprise applications |
| 16 | +with multiple databases. |
| 17 | + |
| 18 | +TypeORM supports both Active Record and Data Mapper patterns, |
| 19 | +unlike all other JavaScript ORMs currently exist, |
| 20 | +which means you can write high quality, loosely coupled, scalable, |
| 21 | +maintainable applications the most productive way. |
| 22 | + |
| 23 | +TypeORM is highly influenced by other ORMs, such as [Hibernate](http://hibernate.org/orm/), |
| 24 | + [Doctrine](http://www.doctrine-project.org/) and [Entity Framework](https://www.asp.net/entity-framework). |
| 25 | + |
| 26 | +Some of TypeORM features: |
| 27 | + |
| 28 | +* supports both DataMapper and ActiveRecord (your choice) |
| 29 | +* entities and columns |
| 30 | +* database-specific column types |
| 31 | +* entity manager |
| 32 | +* repositories and custom repositories |
| 33 | +* clean object relational model |
| 34 | +* associations (relations) |
| 35 | +* eager and lazy relations |
| 36 | +* uni-directional, bi-directional and self-referenced relations |
| 37 | +* supports multiple inheritance patterns |
| 38 | +* cascades |
| 39 | +* indices |
| 40 | +* transactions |
| 41 | +* migrations and automatic migrations generation |
| 42 | +* connection pooling |
| 43 | +* replication |
| 44 | +* using multiple database connections |
| 45 | +* working with multiple databases types |
| 46 | +* cross-database and cross-schema queries |
| 47 | +* elegant-syntax, flexible and powerful QueryBuilder |
| 48 | +* left and inner joins |
| 49 | +* proper pagination for queries using joins |
| 50 | +* query caching |
| 51 | +* streaming raw results |
| 52 | +* logging |
| 53 | +* listeners and subscribers (hooks) |
| 54 | +* supports closure table pattern |
| 55 | +* schema declaration in models or separate configuration files |
| 56 | +* connection configuration in json / xml / yml / env formats |
| 57 | +* supports MySQL / MariaDB / Postgres / SQLite / Microsoft SQL Server / Oracle / WebSQL |
| 58 | +* supports MongoDB NoSQL database |
| 59 | +* works in NodeJS / Browser / Ionic / Cordova / Electron platforms |
| 60 | +* TypeScript and JavaScript support |
| 61 | +* produced code is performant, flexible, clean and maintainable |
| 62 | +* follows all possible best practices |
| 63 | +* CLI |
| 64 | + |
| 65 | +And more... |
| 66 | + |
| 67 | +See more documentation on a [website](http://typeorm.io). |
0 commit comments