About

This project is just for study the core concepts on a NodeJS API throw a minimum, complete and well done project. We just use some basic frameworks, see our package.json

Git Repo https://github.com/isidoromendez/tsc-api-studio

Concepts that we explore here:

1. Conventional commits
2. Architecture
   1. Define Architecture (Clean Arquitecture)
   2. Document architecture
   3. Document procedures for developers
3. Security
   1. CORS
   2. JWT authentication + autorization
   3. API Keys
4. Restful Statelessness
   1. Caching
   2. Compression
   3. Content Negotiation
   4. HATEOAS
   5. Idempotence
   6. Security Essentials
   7. Versioning
   8. Statelessness
5. Forking
   1. Need architecture support for forked process? Forking example
6. Errors strategy
   1. Response codes HTTP Response Codes

Recomended documentation for the our stack

• JavaScript Documentation
• TypeScript Documentation
• Clean code
• Design patterns and refactoring
• Rest Full
• Git
• Semantic Versioning
• Conventional Commits
• Jest
• OWASP
• NodeJS Security Cheat Sheet
• NodeGoat

How to colaborate

Create an issue or colaborate with an exiting one

1. Fork this repo
2. Create a branch to work on the issue
3. Commit usin convetional commits and tag use hashtag '#n' in the descrition to link the issue you worked on
4. Make a pull request to our project