Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akshatbhargava123/bulletproof-nodejs-typeorm
https://github.com/akshatbhargava123/bulletproof-nodejs-typeorm
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/akshatbhargava123/bulletproof-nodejs-typeorm
- Owner: akshatbhargava123
- License: mit
- Created: 2020-04-16T04:39:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T14:57:15.000Z (almost 2 years ago)
- Last Synced: 2023-03-08T12:57:59.750Z (over 1 year ago)
- Language: TypeScript
- Size: 2.05 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bulletproof Node.js architecture with TypeORM (PostgreSQL) 🛡️
This is a template fork repo of Bulletproof NodeJS repo [here](https://github.com/santiq/bulletproof-nodejs) which I customised according to my needs.
- Made AgendaJS optional since Job scheduling is not a usual thing in the initial requirements.
- Added TypeORM and totally removed Mongoose.
## Development
We use `node` version `10.15.0`
```
nvm install 10.15.0
```
```
nvm use 10.15.0
```
The first time, you will need to run
```
npm install
```
Then just start the server with
```
npm run start
```
It uses nodemon for livereloading :peace-fingers:
# API Validation
By using celebrate the req.body schema becomes clary defined at route level, so even frontend devs can read what an API endpoint expects without need to writting a documentation that can get outdated quickly.
```js
route.post('/signup',
celebrate({
body: Joi.object({
name: Joi.string().required(),
email: Joi.string().required(),
password: Joi.string().required(),
}),
}),
controller.signup)
```
**Example error**
```json
{
"errors": {
"message": "child \"email\" fails because [\"email\" is required]"
}
}
```
[Read more about celebrate here](https://github.com/arb/celebrate) and [the Joi validation API](https://github.com/hapijs/joi/blob/v15.0.1/API.md)
# Roadmap
- [x] API Validation layer (Celebrate+Joi)
- [ ] Unit tests examples
- [ ] [Cluster mode](https://softwareontheroad.com/nodejs-scalability-issues?utm_source=github&utm_medium=readme)
- [x] The logging _'layer'_
- [ ] Add agenda dashboard
- [x] Continuous integration with CircleCI 😍
- [ ] Deploys script and docs for AWS Elastic Beanstalk and Heroku
- [ ] Integration test with newman 😉
- [ ] Instructions on typescript debugging with VSCode
# FAQ
## Where should I put the FrontEnd code? Is this a good backend for Angular or React or Vue or _whatever_ ?
[It's not a good idea to have node.js serving static assets a.k.a the frontend](https://softwareontheroad.com/nodejs-scalability-issues?utm_source=github&utm_medium=readme)
Also, I don't wanna take part in frontend frameworks wars 😅
Just use the frontend framework you like the most _or hate the least_. It will work 😁
## Don't you think you can add X layer to do Y? Why do you still use express if the Serverless Framework is better and it's more reliable?
I know this is not a perfect architecture but it's the most scalable that I know with less code and headache that I know.
It's meant for small startups or one-developer army projects.
I know if you start moving layers into another technology, you will end up with your business/domain logic into npm packages, your routing layer will be pure AWS Lambda functions and your data layer a combination of DynamoDB, Redis, maybe redshift, and Agolia.
Take a deep breath and go slowly, let the business grow and then scale up your product. You will need a team and talented developers anyway.
### Credits
Again, all work credit in this repo goes to the Author [Sam Quinn](https://github.com/santiq) as I've just customised it for personal use.