Jestpress (beta)

[!NOTE] Hey there! This is a work in progress. And I'll not yet be bumping a major version for breaking changes. SO, please, consider this as a beta version. If you have any suggestions or would like to contribute, feel free to reach out to me.

Elevate Your API development Experience with jestpress!

jestpress is not just a boilerplate, it's your launchpad into the future of API development. Unleash the power of mvc architecture and effortlessly organize your project for success.

🎨 Features

• MVC architecture: Organize your components utilizing the model view controller architecture.

🚀 Quick Start

Jestpress works by setting up a new Node express application with the MVC architecture. To get started, install jestpress globally:

npm install -g jestpress

🚦 Usage

Generate a new application effortlessly:

# Create a new application in the current directory
jestpress create ./

Or specify a folder:

# Create a new application in a specified directory
jestpress create my-api

🏗️ MVC architecture

jestpress follows the mvc architecture. Here's a brief overview of the project structure:

/api # API folder contains all your application logic
-- /v1 # API version 1
-- -- /models # Models for the API

📜 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

🌈 Contribute

If you would like to contribute to this project, please read the CONTRIBUTING.md file for details.

🐞 Issues

Encountering any issues? Report them on the Github Issues page. We're here to help!

Development progress

1. [x] Create a new application
2. [x] Add support for multiple models
3. [x] Add support for multiple controllers
4. [x] Add support for multiple routes
5. [x] Add support for multiple middlewares
6. [x] Add support for multiple services
7. [x] Add support for multiple utils
8. [x] Add support for multiple helpers
9. [x] Add support for error handling
10. [x] Add support for multiple API versions
11. [ ] Add support for logging
12. [x] Add support for Docker
13. [ ] Add support for testing
14. [x] Add support for security
15. [x] Add support for rate limiting
16. [x] Add support for deployment(NOT FULLY TESTED)
17. [ ] Add support for documentation
18. [ ] Add support for api routing via command line
19. [ ] Add support for configuration via config file
20. [ ] Add support for configuration via command line
21. [ ] Add support for CI/CD
22. [ ] Add support for multithreading
23. [ ] Add support for clustering
24. [ ] Add support for load balancing
25. [ ] Add support for caching
26. [ ] Add support for monitoring
27. [ ] Add support for authentication

• [ ] Add middleware for authentication
• [ ] Support for JWT
• [ ] Support for OAuth2
• [ ] Support for OpenID Connect
• [ ] Support for SAML
• [ ] Support for LDAP
• [ ] Support for API keys
• [ ] Support for Basic Auth
• [ ] Support for Digest Auth
• [ ] Support for HMAC
• [ ] Support for OAuth

28. [ ] Add support for authorization

• [ ] Add middleware for authorization

29. [ ] Add support for validation
30. [ ] Add support for localization
31. [ ] Add support for internationalization

📝 Author

• Satil Pereira

What to expect in the near future?

This project is mainly aimed for my own personal projects. However, I'm open to suggestions and contributions. If you have any ideas or would like to contribute, feel free to reach out to me.

Feel free to further customize the content or let me know if you have specific elements you'd like to emphasize! I'm happy to help. 😊