ExpressTemplate/README.md

49 lines
1.5 KiB
Markdown
Raw Normal View History

2023-11-24 00:13:48 +01:00
# Jo's Express Template / JET ;)
2023-11-23 23:19:45 +01:00
2023-11-24 00:13:48 +01:00
## 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](https://textkool.com/en/ascii-art-generator?hl=default&vl=default&font=Train&text=%20Jo))
```js
// _
// o O O _ | | ___
// o | || | / _ \
// TS__[O] _\__/ \___/
// {======|_|"""""|_|"""""|
// ./o--000'"`-0-0-'"`-0-0-'
//
// Code written by «Johannes Reckers»
//------------------------------------------------>
```
#### [ ↓ ] Categories
```js
//------------------------------------------------>
// Category description
//------------------------------------------------>
```
#### [ ↓ ] Sub-Categories
```js
//-------------------<[ 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
* [Better Comments](https://open-vsx.org/extension/edwinhuish/better-comments-next)
* [ESLint](https://open-vsx.org/extension/dbaeumer/vscode-eslint)