Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.52 KB

README.md

File metadata and controls

71 lines (44 loc) · 2.52 KB

Typescript Express Template

Build Status

typescript Express Template is an easy to use (create-react-app style) template that you can use on the fly to create your app.

it is based on the MVC framwork, without the V for View. the View is usually used in a SPA (react or angular or vue)

The concept is to use the latest and best libraries in the market to make development more about the code and less about the setup procedure and have a uniform structure accross your team!

Installation

typescript express template requires Node.js to run.

Install the dependencies and devDependencies and start the server.

Clone this template into your local environemnt Write all your code inside the ./src directory

There must always be an index.js file inside the ./src directory (starting point)

$ cd typescript-express-tempalte
$ npm install
$ npm start

For production environments...

$ npm install --production
$ npm run test
$ npm run build

NPM scripts

These are short commands to help you run your app quickly and without any effeort.

run npm start to start your development server

run npm run test to perform any tests in your projects (all tests are done using JEST library)

run npm run build after you pass all tests to build a production bundle (using webpack)

Tech

typescript-express-template uses a number of open source projects to work properly:

  • Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Typescript - TypeScript extends JavaScript by adding types.
  • Express - Fast, unopinionated, minimalist web framework for Node.js
  • Jest - a delightful JavaScript Testing Framework
  • Webpack - Javascript bundler for production

And of course typescript-express-template itself is open source with a public repository on GitHub.

Free Software, Hell Yeah!