From c8afc3b0df63af09b693815b2d9d432cd2aaacca Mon Sep 17 00:00:00 2001 From: Kato Twofold Date: Sat, 29 May 2021 18:43:59 +0300 Subject: [PATCH] --- Home.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..36a394e --- /dev/null +++ b/Home.md @@ -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. \ No newline at end of file