Kato Twofold 2021-05-29 18:43:59 +03:00
commit c8afc3b0df
1 changed files with 18 additions and 0 deletions

18
Home.md Normal file

@ -0,0 +1,18 @@
# About
The Express TypeScript BoilerPlate is an extremely minimal **Starting Point** for an awesome start with TypeScript and Express.
I found it infuriating when I was a beginner to initalize my project correctly with a manageable project structure.
# Usage
##### Development
To start the project you must first run the `npm i` command, this will go ahead and install all of the required packages for you to be able to get started with development/running. Now to customize your options simply create the `.env` file and fill in the details.
To run the project simply type out `npm test`, this will run the project for you.
##### Production
To start off in production mode ( To run a finished project based on this boilerplate ) simply run the `npm install --production` on the production machine when moving projects, afterwards run the start command with the appropiate parameters for your project, this can either be the developer start command or a custom command you yourself setup.
# Branches
##### Master
The `master` branch will include just the basics and it's the `base-model` of the whole repository.
##### FrameWork
I do also offer a "full package" version in the form of the `FrameWork` branch, where the templating engine `HandleBars`, I love the fact that it preserves consistency, it's straightforward and it renders server-side.