Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wriar/express-ts-ejs-secure-boilerplate
A TypeScript boilerplate template for full-stack HTTPS production express apps.
https://github.com/wriar/express-ts-ejs-secure-boilerplate
Last synced: 4 days ago
JSON representation
A TypeScript boilerplate template for full-stack HTTPS production express apps.
- Host: GitHub
- URL: https://github.com/wriar/express-ts-ejs-secure-boilerplate
- Owner: Wriar
- License: mit
- Created: 2024-10-16T23:17:20.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T03:57:16.000Z (3 months ago)
- Last Synced: 2024-10-20T04:38:33.839Z (3 months ago)
- Language: TypeScript
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# express-ts-ejs-scss-HTTPS-boilerplate
A TypeScript boilerplate template for full-stack HTTPS production express apps.
TypeScript is setup and configured, as well as a HTTP/HTTPS server with express-session. EJS as the view engine is included as well SASS for CSS. Nodemon Development, SASS Support, and TSC compiler are setup out-of-box.
> [!IMPORTANT]
> HTTPS is enabled by default! You will need to use ``.generateCertificates.ps1`` script to create a self-signed certificate/key pair. If you do not want to use HTTPS, set ``useSSL = false`` in ``server.ts``.
>
> **It is advised to use THIS tool to generate SSL certificates that should most likely be TRUSTED by most browsers, as long as the cert is installed in the computer's trusted root certificate authority.**
>
> **For FireFox Users:**
> You will need to import the generated ``cert.crt`` into the browser's OWN certificate store AS WELL to disable the insecure SSL warning.
>
> ``Tools > Options > Advanced > Certificates: View Certificates``
## Out-Of-Box Quick Setup:
1. Clone template repo. Run ``npm install``. Update any NPM packages if needed.
2. Create certificates using ``.generateCertificates.ps1`` script. Copy ``cert.crt`` and ``key.key`` to ``/certs``. Optionally install the cert.crt into your device's trusted root certificate store (see above for FireFox setup)
3. Copy ``.env.example`` to ``.env``.
4. Run ``npm run build-standalone``. Verify the HTTPS server starts (HELLO WORLD at 'https://localhost/')
5. Use ``npm run b`` to run SCSS parser; Use ``npm run dev`` to use server w/ nodemon. THese are the standard development commands.
## NPM Scripts:
* ``build-standalone``: Builds the project into ``./bin`` and runs it with TSC.
* ``dev``: Spinup a dev environment which will rebuild/restart each time a TS script is modified in the ``/src`` folder.
* ``b``: Start the SCSS parser & builder. sass files should be placed in ``static/scss``.
* ``clean``: Purge the ``./bin`` folder.
It is recommended to start both ``dev`` and ``b`` scripts to develop frontend/backend respectively. All fresh restarts of build & dev will copy over static resources to bin (those not copied over by TSC).
> [!WARNING]
> To build a standalone **portable** app in `./bin`, make sure the ``server.ts`` sets up the static directory as ``./bin/static`` NOT ``./src/static``. Even though static is copied over on each TSC build, they are not re-copied during nodemon-monitored changes (it is not ideal for nodemon to restart the server each time a static resource is updated, so ``./src/static`` is set to be ignored by nodemon). This is not a concern unless you are only wanting to use the bin folder in a distribution. To correctly build a bin distribution, set ``IS_DEBUG=False`` in server.ts and run ``npm run build-standalone``!
### TypeScript Target/Module: ``es2016`` & ``commonJS``
## Pre-Installed Packages:
Ensure to run ``npm install && npm upgrade`` and install all production and development packages before using. The versions listed below may not be up to date; upgrade if needed.
```json
"dependencies": {
"axios": "^1.6.4",
"bcrypt": "^5.1.1",
"cookie-parser": "^1.4.6",
"dotenv": "^16.0.3",
"ejs": "^3.1.9",
"express": "^4.18.2",
"express-rate-limit": "^7.1.4",
"express-session": "^1.17.3",
"mariadb": "^3.2.2",
"typescript": "^5.3.3"
},
"devDependencies": {
"@types/bcrypt": "^5.0.2",
"@types/cookie-parser": "^1.4.7",
"@types/express": "^4.17.17",
"@types/express-session": "^1.17.7",
"concurrently": "^8.0.1",
"copyfiles": "^2.4.1",
"nodemon": "^3.0.1",
"rimraf": "^6.0.1",
"scss": "^0.2.4"
}
```