├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Leka-Workshop 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Express-APIvantage 2 | Build a well-organized Express.js project using TypeScript, ESlint, SQL & NoSQL database, environment variables, and more. 3 | 4 | 5 | ### Why Express? 6 | Express.js has been around for over a decade. It's easy to learn and minimalistic, but after years of working with frameworks like .NET Web API & Nest.js, going back to Express feels like living in the stone age. 7 |   8 | Almost every repository you come across follows a unique architecture, with different coding patterns and a list of libraries, making it a nightmarish learning experience for newcomers. 9 | It's hard to find a good project online that fits your needs and at the same time: 10 | * Uses strict typing 11 | * Has database set up (SQL / NoSQL) 12 | * Secure 13 | * Scalable 14 | * Well documented 15 | * Ready for deployment 16 | 17 | This project aims to achieve all that. From starter tools to a production-ready product, we'll learn how to build a unified solution that can be easily extensible with new features. With each new chapter, we'll improve upon the previous codebase. 18 | 19 | ### Branches: 20 | * [1-Starter-API](https://github.com/Leka-Workshop/Express-APIvantage/tree/1-Starter-API) 21 | * [2-API-Validations](https://github.com/Leka-Workshop/Express-APIvantage/tree/2-API-Validations) 22 | * [3-Logging](https://github.com/Leka-Workshop/Express-APIvantage/tree/3-Logging) 23 | * [4-Error-Handling](https://github.com/Leka-Workshop/Express-APIvantage/tree/4-error-handling) 24 | 25 | ### Blogs: 26 | * [How to set up starter project](https://mirzaleka.medium.com/express-js-starter-api-with-typescript-deef5c4b6b70) 27 | * [How to validate APIs](https://mirzaleka.medium.com/api-validations-in-express-js-5d1d308dceea) 28 | * [Automated Logging in Express.js](https://medium.com/@mirzaleka/automated-logging-in-express-js-a1f85ca6c5cd) 29 | * [Build a Global Exception Handler](https://mirzaleka.medium.com/build-a-global-exception-handler-using-express-js-typescript-b9bb2f521e5e) 30 | --------------------------------------------------------------------------------