docs, ratelimit, cors

modified documentation, change default ratelimit and cors value
surelle-ha · Jun 17, 2024 · 768f48c · 768f48c
1 parent eb01085
commit 768f48c
Show file tree

Hide file tree

Showing 5 changed files with 142 additions and 22 deletions.
diff --git a/.env.example b/.env.example
@@ -2,7 +2,7 @@ SERVER_NAME = "ZentinelJS"
 SERVER_ENV = "local"
 SERVER_VER = "v1.0.0"
 SERVER_BASE = "http://localhost"
-SERVER_PORT = 80
+SERVER_PORT = 8800
 JWT_SECRET = "test"
 
 # NOSQL CONFIG

diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
-<div align="center">
-	<h1 style="letter-spacing: 7px">ZENTINEL.JS</h1>
-</div>
-
-Zentinel.JS is a backend framework / boilerplate built on top of Express.JS, structured to mirror the Laravel directory format for a familiar setup. It includes Artisan-like commands called 'Zentinel' to streamline development tasks, offering a powerful toolset for efficient backend operations and seamless integration.
-
 <div id="badges" align="center">
 	<div align="center">
-		<img src="https://media2.giphy.com/media/bGgsc5mWoryfgKBx1u/200w.gif?cid=6c09b95248puaf5xo1jzqdo1jhpx9dg9aa99b6mwgo05b22o&ep=v1_gifs_search&rid=200w.gif&ct=g" width="600" height="300"/><br><br>
+		<img src="https://64.media.tumblr.com/116c77d969e3c334de736e6e496d3279/tumblr_p1bo6rLBjM1v1b8nao1_540.gifv" width="200" height="200"/><br><br>
 	</div>
 </div>
 
+<div align="center">
+	<h1 style="letter-spacing: 7px">ZENTINEL.JS</h1>
+</div>
+
+Zentinel.JS is a backend boilerplate built on top of Express.JS, structured to mirror the Laravel directory format for a familiar setup. It includes Artisan-like commands called 'Zentinel' to streamline development tasks, offering a powerful toolset for efficient backend operations and seamless integration.
+
 <div align="center">
 
 ![ExpressJS](https://img.shields.io/badge/Express.JS-black?style=for-the-badge&logo=express)
@@ -21,9 +21,10 @@ Below are the features of Zentinel.JS:
 - Zentinel CLI
 - Builtin Authentication using JSON Web Token.
 - Builtin Role-Based Access Control as Authorization.
-- Configured Mongoose for MongoDB 
-- Configured Sequelize for MySQL
-- Configured CORS, Helmet and Securities
+- Preconfigured Mongoose for MongoDB 
+- Preconfigured Sequelize for MySQL
+- Preconfigured Rate Limit, CORS, Helmet and Securities Modules
+- Preconfigured Logs and PM2 Setup
 - Interconnected MVC Components
 - Sequelize UI / ORM Code Generator
 
@@ -52,7 +53,9 @@ npx sequelize-cli db:migrate
 npx sequelize-cli db:seed:all
 zentinel dev
 ```
-Manual Installation via Github: To install and start developing with Zentinel, follow these steps:
+
+**Manual Installation via Github: To install and start developing with Zentinel, follow these steps:**
+
 Clone the repository:
 ```bash 
 git clone https://github.com/surelle-ha/zentineljs.git
@@ -68,17 +71,34 @@ Set the environment variables
 cp .env.example .env
 # open .env and modify the environment variables (if needed)
 ```
+Create Database
+```bash
+npm run db:up
+```
 Migrate Database
 ```bash 
 npx sequelize-cli db:migrate
+# OR
+npm run db:migrate
 ```
 Seed Default Data
 ```bash 
 npx sequelize-cli db:seed:all
+# OR
+npm run db:seed:all
+```
+Start Local Server
+```bash
+npm run dev # Development Environment
+npm run prod # Production Environment
 ```
-Start Server
+By Default, you'll see the Documentation as it's homepage. 
 ```bash
-npm run dev
+GET https://localhost:8800/
+```
+There are other extension modules I'm planning to implement. Right now, you can use the [ORM Builder](https://github.com/tomjschuster/sequelize-ui) installed in the Zentinel.
+```bash
+GET https://localhost:8800/orm-builder
 ```
 
 ## Commands
@@ -131,7 +151,7 @@ const RateLimit = rateLimit({
 })
 ```
 - [2024/06/06] Sequelize ORM - Object/Relational Mapping (ORM) framework for Node. js applications. It enables JavaScript developers to work with relational databases, including support for features such as solid transaction support, relations, read replication, and more.
-- [2024/06/08] Zentinel CLI is a commandline interface tool to manager and initialize Zentinel Backend Boilerplate/Framework. To learn more about ZentinelJS, visit the repository.
+- [2024/06/08] Zentinel CLI is a commandline interface tool to manager and initialize Zentinel Backend Boilerplate. To learn more about ZentinelJS, visit the repository.
 ```bash
 npm i zentinel-cli
 zentinel --help
@@ -161,10 +181,59 @@ zentinel create
 - [x] Sequelize ORM Code Generator added
 
 ## Developer
-As a developer who constantly seeks to improve my development skills, my goal with Zentinel.JS is to create a powerful yet intuitive backend framework that simplifies the development process for fellow developers. I aim to provide a robust toolset that makes backend operations more efficient and enjoyable, ensuring that developers can focus on building great applications without getting bogged down by repetitive tasks.
+As a developer who constantly seeks to improve my development skills, my goal with Zentinel.JS is to create a powerful yet intuitive backend boilerplate that simplifies the development process for fellow developers. I aim to provide a toolset that makes backend operations more efficient and enjoyable, ensuring that developers can focus on building great applications without getting bogged down by repetitive tasks.
+
+I envision Zentinel.JS as a go-to boilerplate for developers who appreciate the structure and convenience of Laravel but prefer to work within the Node.js ecosystem. By combining the best aspects of both worlds, I hope to foster a community where developers can share their experiences, contribute to the project's growth, and continuously improve their craft. Ultimately, Zentinel.JS will empower developers to create scalable, secure, and high-performance applications with ease, making backend development more accessible and enjoyable for everyone.
+
+# Contributing to Zentinel.JS
+
+We appreciate your interest in contributing to our project. Zentinel.JS aims to provide a powerful and intuitive backend boilerplate, and contributions from developers like you help us achieve and maintain this goal.
+
+## Quick Start for Contributors
+
+To get started, here’s what you need to know:
+
+### Code of Conduct
+We prioritize creating a respectful and inclusive environment. Please review and adhere to our Code of Conduct to ensure a positive experience for all collaborators.
+
+### Reporting Bugs
+If you find a bug in the codebase:
+1. **Check Existing Issues:** Verify if the issue has already been reported to avoid duplication.
+2. **Create a Detailed Issue:** Include a descriptive title, a clear explanation of the problem, steps to reproduce, and the expected outcome.
+
+### Feature Requests
+To suggest a new feature:
+1. **Search Existing Suggestions:** Check if someone else has already proposed something similar.
+2. **Submit a New Issue:** Clearly describe the proposed feature, its benefits, and possible implementations.
+
+## How to Contribute Code
+
+### Setting Up Your Development Environment
+1. **Fork the Repository:** Start by forking the Zentinel.JS repository on GitHub.
+2. **Clone Your Fork:** Clone your forked repository to your local machine.
+3. **Install Dependencies:** Navigate to the project directory and run `npm install` to install required dependencies.
+
+### Making Changes
+1. **Create a New Branch:** Use a branch specific to the feature or fix you are working on.
+2. **Commit Changes:** Make your changes in the new branch. Commit messages should clearly explain the purpose of the changes.
+3. **Write Tests:** Add or update tests to cover the new functionality or fixes. Ensure all tests pass.
+
+### Pull Request Process
+1. **Update Your Branch:** Rebase your branch on the latest main branch to ensure a smooth integration.
+2. **Submit a Pull Request (PR):** Push your branch to GitHub and open a PR against the main branch of the original Zentinel.JS repository.
+3. **Review Process:** The project maintainer will review your PR. Be open to making revisions based on feedback.
+4. **PR Approval and Merge:** Once approved, the maintainers will merge your PR.
+
+## Additional Resources
+- **Documentation:** Familiarize yourself with the project documentation to understand how to use and extend Zentinel.JS.
+- ~~**Community:** Join our community forums or chat channels to discuss ideas and ask questions.~~
+
+## Acknowledgments
+Contributors who help improve Zentinel.JS make a significant impact. We appreciate your dedication and effort in enhancing this project.
+
+Thank you for choosing to contribute to Zentinel.JS. We look forward to your contributions!
 
-I envision Zentinel.JS as a go-to framework for developers who appreciate the structure and convenience of Laravel but prefer to work within the Node.js ecosystem. By combining the best aspects of both worlds, I hope to foster a community where developers can share their experiences, contribute to the project's growth, and continuously improve their craft. Ultimately, Zentinel.JS will empower developers to create scalable, secure, and high-performance applications with ease, making backend development more accessible and enjoyable for everyone.
+<a href="https://github.com/surelle-ha/zentineljs/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=surelle-ha/zentineljs" />
+</a>
 
-## Developers
-Surelle-ha - [Github](https://github.com/surelle-ha)::
- _I'm currently looking for contributors to help improve project. Contact me on [Linkedin](https://www.linkedin.com/in/surellejs/), if you're interested._
diff --git a/config/cors.js b/config/cors.js
@@ -2,7 +2,7 @@ const cors = require("cors");
 
 /* Only modify this if you know what you're doing. */
 let allowedOrigins = [
-	"*"
+	"http://localhost:8800"
 ];
 
 const cors_options = {

diff --git a/config/ratelimiter.js b/config/ratelimiter.js
@@ -15,7 +15,7 @@ const RateLimit = rateLimit({
     windowMs: windowM * 60 * 1000,
 
     /* Request Limit Per IP Per Window */
-    limit: 10,
+    limit: 1000000000,
 
     /* draft-6: `RateLimit-*` headers; draft-7: combined `RateLimit` header */
     standardHeaders: 'draft-7',