⚠️ Warning! This project is an artifact of the past, preserved only as a tribute to my coding history. Proceed with caution! 🚧
Once, this project was a beacon of structure and discipline in the chaotic world of backend development. Today, however, it stands as a legacy monument, a testament to a time before the elegance of NestJS.
I've updated the libraries, but let's be honest—this is more of a nostalgic challenge than a practical necessity.
The code still breathes (barely), but the world has moved on. And so should you!
If you're here looking for inspiration, let me save you some time:
✨ Use NestJS instead.
NestJS has already solved the issues I tried to address in this project, and does it better, faster, stronger.
But if you're feeling brave (or just love archeology), feel free to dive into this historical codebase. Just don't say I didn't warn you. 🏴☠️
This example represents one possible implementation of a business logic layer, and serve as the starting point in the training of forming the project structure.
Why "attempt" and not the final realization?
Because the goal of all projects are different, as well as a vision of business issues every developer involved in the project.
The first thing to understand is that there are several so-called layers of your project. I see the project in the following interpretations:
- «Service layer» - the layer which handles the incoming data from the user and generates the necessary answer script as a result of mining
- «Business Layer» - layer which is responsible for a particular function, and does not know anything about the data that actually have been received from the user or from other sources.
- «Data layer» - is responsible for specific transactions are allowed for the current model (table), for example basic CRUD.
This separation helps to better structure your code and avoid piling up logic. Consider this example: user registration. Suppose we have a REST request from a user-defined fields, for simplicity we take the login / password. In this case, the layers will have the following roles:
- Service layer - forming data validity checking username, password as the text values (or other criteria) to clean debris from the data and generate a request to the business layer.
- Business layer - must obtain the "entrance", "clean" data manipulation to spend with them and call the model methods.
- Data layer just manages preservation / creation and other methods and do not know anything about the data itself.
Summarize it in a VERY simplified form
Service layer: clears the data and generates a response from the business layer.
Business layer: performs all data manipulation: the criterion sampling, filters and other "business objectives".
Data layer: performs CRUD operations so that receives from business layer.
In this embodiment, the service layer is «controllers», the business layer is «repositories» and data layer is «models»
Use dynamic-config for config enviroment.
Express as web framework for node.
TypeScript as language for application-scale JavaScript.
JWT for user authorization.
Mocha and Chai for testing, also Chai-http for integration test.
Make git clone or zip download and move to the directory
sudo npm install -g gulp typescript
npm install
npm run build
npm run start
Use mocha, chai and chai-http for test.
gulp test
This code is implemented model of the user including the CRUD operations and authorization based on token jwt and of course it is accompanied by tests. Good luck!
MIT License
Copyright (c) [2017] [Brickiy Sergey]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.