tillhoffmann1411 / node-boilerplate

A boilerplate template for NodeJS projects.

node-boilerplate

A boilerplate template for NodeJS projects.

Setup

1. Create a .env file in the root directory with following settings:

PORT=80

MONGO_USERNAME=
MONGO_PASSWORD=
MONGO_PORT=27017
MONGO_DB=mongodb

JWT_KEY=
COOKIE_SECRET=  

2. With docker-compose up you can start the server.
3. Test your running backend Postman API documentation

What belongs where

Folder	Contains
config	Configurations for packages.
controllers	Logic behind the routes but delegate the main logic to services. Handle here errors.
interfaces	Implement your typescript interfaces here.
middleware	Express middlewares are here implemented.
models	Mongoose models are here defined
routes	Define your different routes here.
services	Main logic divided according to the data they use. This is where database accesses take place.

Feel free to use commit emojis for some color and easy to understand commit messages.

node-boilerplate's Issues

jwt expires

The Token Object of JWT contains expires, but the cookie must also, otherwise its just working for one session.

node-image noch buggy im Bezug auf npm

Irgendwann habe ich in offiziellen Vorträgen rausgefunden, dass für jegliche externe Bibliothek die man in den $PATH installiert ein best-practise ist, diese per Entrypoint aufzurufen.
Das hat den Vorteil, dass dann die Volumes schon gemounted sind, man muss also vorher kein Copy mehr machen und das wird ggf. vom Volume überschrieben (das ist aktuell der Fall). Außerdem werden beim Image-bauen teilweise Systembibliotheken vom HOST im RUN verwendet, was zu ekeligen Fehlern führen kann.
Hier also mal ein anderes Herangehen, damit hatte ich bisher die allerwenigsten Probleme:

Dockerfile

FROM node

ADD ./node_startup.sh /
RUN ["chmod", "+x", "/node_startup.sh"]

EXPOSE 3000

ENTRYPOINT ["/node_startup.sh"]

CMD [ "npm", "run", "start:watch" ]

node_startup.sh

#!/bin/bash

npm install
npm run build

exec "$@"

Auf macOS und Linux getestet, funktioniert problemlos. Windows... your thing ;)

signup 2x with same email

When singing up two times with the same email nodejs throws mongodb error as follows:

Maybe wanted?

updateOne doesnt update password correctly

In user.model.ts UserSchema.pre('save'...) doesnt get called when using updateOne according to "Pre and post save() hooks are not executed on update(), findOneAndUpdate(), etc. " on https://mongoosejs.com/docs/middleware.html#order.

So a small fix:

UserSchema.pre('updateOne', async function (next) {
const user = this.getUpdate();
if(user.password) {
user.password = await bcrypt.hash(user.password, bcrypt.genSaltSync());
this.update({}, user).exec()
}
next()
});

Threre will be a better solution using the IUserSchema - but i dont know how to get there from the Query Object 💯