https://github.com/filibit/clean-node-api
A web API demonstrating Clean Code paradigm and SOLID principles
https://github.com/filibit/clean-node-api
Last synced: 3 months ago
JSON representation
A web API demonstrating Clean Code paradigm and SOLID principles
- Host: GitHub
- URL: https://github.com/filibit/clean-node-api
- Owner: filiBit
- License: unlicense
- Created: 2021-11-07T12:21:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-21T22:11:18.000Z (over 4 years ago)
- Last Synced: 2024-12-31T19:45:52.825Z (over 1 year ago)
- Language: JavaScript
- Size: 92.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A web API that demonstrates some of the arguably best coding practices.
Inspired by **Clean code** paradigm and **SOLID principles**.
## Info
- The API is RESTful and written in Javascript (Node.js environment)
- The only production dependencies are Node's built-in modules
- **It's work in progress**
## Usage
1. Run the following command inside the project folder: `node index.js`
2. After the app is built and started, you should see a message about the server state
## Known Issues:
- **Case insensitive data operations:** In some environments, methods in Node's File System (`fs`) module have case insensitive path arguments, which can make data operations perform on untargeted resources.
## Any questions?
filip.biterski@gmail.com