This serves as a base for small projects with Express.js and TypeOrm.
This is a small project where some things are already set up to get you started. To use it, clone this repo, install NodeJS and run npm install in the project directory. This will install all dependencies and you can start.
The project is written in TypeScript which transpiles to JavaScript in the build directory. To build it the command npm run build can be used.
For a quick development server you can run npm run start. Once the server is started it can be accessed at http://localhost:3000.
The web server uses Express.js which is based on middlewares. A json middleware is included and already set up so the API can send and receive JSON responses and requests.
To keep things simple SQLite is used as a database. As ORM TypeORM which plays nicely with TypeScript.
- With
npm run startTS Node is used to directly run the code. Normally you would have to transpile it first (you can do so withnpm run build) butTS-Nodewill transpile files on the fly. - Database configuration is done in
ormconfig.jsonand when you run the server withTS Nodeit will automatically be picked up and used for connection. You can also manually configure the connection directly in the code. - If you want to transpile manually and run the transpiled code yourself (for example with
node build/index.js) you'll have to provide database configuration otherwise, since the default conifugration points to the directory containing theTypeScriptfiles for entities. See the TypeORM docs for more information. - If
synchronize: trueis set in the TypeORM connection settings the database schema is automatically updated from the entities TypeORM found. More info is found in the TypeORM docs. - You can enable schema and query logging in the connection settings. See the TypeORM docs for more information.