JET < Jo's Express Template > is a simple template for creating new express applications. It includes a basic express setup, configured to suit my needs. Additionally, there are well documented guidelines that help keep my codebases organized and maintainable.
Find a file Use this template
2023-11-26 01:16:08 +01:00
.gitea/workflows chore: add gitea action on push 2023-11-26 01:16:08 +01:00
config refactor: improve env loading 2023-11-26 00:25:28 +01:00
controller update eslint config and add placeholders 2023-11-24 00:17:25 +01:00
model update eslint config and add placeholders 2023-11-24 00:17:25 +01:00
public update eslint config and add placeholders 2023-11-24 00:17:25 +01:00
routes update eslint config and add placeholders 2023-11-24 00:17:25 +01:00
views chore: add gitea action on push 2023-11-26 01:16:08 +01:00
.eslintrc.js update eslint config and add placeholders 2023-11-24 00:17:25 +01:00
.gitignore first real commit 2023-11-24 00:13:48 +01:00
app.js refactor: improve env loading 2023-11-26 00:25:28 +01:00
docker-compose.yml refactor: improve env loading 2023-11-26 00:25:28 +01:00
Dockerfile refactor: improve env loading 2023-11-26 00:25:28 +01:00
entrypoint.sh refactor: improve env loading 2023-11-26 00:25:28 +01:00
example-compose.yml refactor: improve env loading 2023-11-26 00:25:28 +01:00
example.env first real commit 2023-11-24 00:13:48 +01:00
LICENSE first real commit 2023-11-24 00:13:48 +01:00
package-lock.json refactor: improve env loading 2023-11-26 00:25:28 +01:00
package.json refactor: improve env loading 2023-11-26 00:25:28 +01:00
README.md first real commit 2023-11-24 00:13:48 +01:00

Jo's Express Template / JET ;)

Initialize a new project

All you really need to do, is to make a copy of example.env and name it ".env". Finally, replace the values as required and enjoy your new Express server :)

Code Structure

One of the most important aspects of a template like this one is, that it gives the developer some kind of base guidelines to work with. This includes, but is not limited to, comments, code dividers, and more...

Dividers

The dividers that may be commonly seen in this template are as follows:

[ ↓ ] Watermark (ASCII generator)

//               _
//    o O O   _ | |   ___
//   o       | || |  / _ \
//  TS__[O]  _\__/   \___/
//  {======|_|"""""|_|"""""|
// ./o--000'"`-0-0-'"`-0-0-'
//
// Code written by «Johannes Reckers»
//------------------------------------------------>

[ ↓ ] Categories

//------------------------------------------------>
// Category description
//------------------------------------------------>

[ ↓ ] Sub-Categories

//-------------------<[ x_x ]>
// Sub-Category description
//---[ ↓ ]

Comments

TODO: Add guidelines for comments

IDE Setup

Here are some general IDE setup tips and plugins which were used during this templates creation.

VSCodium/Code

Plugins