This repository gives the developer an Express Starter written in Typescript to kick off there development fast 🔥🔥🔥
This is inspired from the Java - Struts Framework which we customized to make an opinionated starter pack for the developer to kick off there development fast.
We also promote the Single Responsibility principle as we believe that it will be easier to maintain and provide unit tests when it scales up.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Node 8.4.0 or higher (you can try to manage your versions using nvm)
-
Set up your database and make sure you change the config to your own setup. You can find your database config under
config/ormconfig.jsonfor your development environment. Change accordingly to your chosen environment (test/production){ "type": "postgres", "host": "localhost", "port": 5432, "username": "sample", "password": "sample", "database": "sample", "logging": false }For more info like supported database driver visit TypeORM.
-
And start your application by running this in the terminal. This would watch for changes and rebuild(transpiled) your application
npm run watch
With that, you can see in your terminal that the app is ready to listen for requests. For example:
server listening at http://localhost:3000
To run the test suites, type in your terminal
npm run test
Take note that you need to change your database config for test environment. See installing on how to setup database.
- Routing controllers - Web framework
- TypeORM - Database Management
- TypeDI - Dependencies injection
Open for pull requests!
We use SemVer for versioning. For the versions available, see the tags on this repository
- Hands down for the great works of pleerock