Merge branch 'main' of https://github.com/Axnjr/Blazze.js

Author: Yakshit chhipa

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yakshit Chhipa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,30 +1,42 @@
 <div align="center">
 
-  <h1 style="font-size:5rem">Blazze.js</h1>
+  ![Screenshot 2024-01-21 153036-modified](https://github.com/Axnjr/Blazze.js/assets/111436589/cad139ae-a2e0-4f39-9c1a-ee99c63f732a)
+  
+  <br> 
 
   <a>![Static Badge](https://img.shields.io/badge/TypeSafe-8A28E2)</a> 
   <a>![Static Badge](https://img.shields.io/badge/API%20Dev-%201A18A0)</a> 
   <a>![Static Badge](https://img.shields.io/badge/OpenSource%20-%20%23fff?logoColor=%23fff&labelColor=%23fff&color=%23fff)</a>
   <a>![Static Badge](https://img.shields.io/badge/Express-%20%20%23FF00FF)</a>
   <a>![Static Badge](https://img.shields.io/badge/SWC-%20?logoColor=%23000&color=%2300FFF3)</a>
-  <a>![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FYC59094) </a>
+  <a href="https://twitter.com/Blazzejs">![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FBlazzejs)</a>
   <a>![Static Badge](https://img.shields.io/badge/v.1.2.3%20-%20%230213FF)</a>
   <a>![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/Axnjr/Blazze.js?logoColor=%23000&labelColor=%23F4FF00&color=%23FC9300)</a>
+
+  <br>
 
 </div>
 
-A light-weight express framework to write typesafe API's with zero configuration, no boiler-plate blazingly fast. Blazze.js is a powerful and lightweight JavaScript framework designed to simplify web development. With a focus on simplicity and performance, Blazze.js provides a set of features that make building web applications a breeze.
+A lightweight express framework to write typesafe APIs with zero configuration, no boilerplate blazingly fast. Blazze.js is a powerful and lightweight JavaScript framework designed to simplify web development. With a focus on simplicity and performance, Blazze.js provides a set of features that make building web applications a breeze.
 
 ## Features
-- __`Request Caching:`__ Blazze handles caching automatically to optimize large computations.
-- __`Powered by SWC:`__ Super speed transpilation via the power of Rust.
-- __`Easy Setup:`__ Hit `npx blazze-init` to start building your projects.
-- __`TypeScript:`__ Out of the box TS support, no configurations and environment setup, just get started directly.
-- __`Directory based Routing:`__ Keep the logic separated without any setup. Routes are based on the directory structure.
-- __`Fast & Robust:`__ Built on top of express, for better developer experience.
-- __`No Boiler Plate Code:`__ Install init and start, Nothing else 🚀
-- __`Build Optimization:`__ Makes a single optimized bundle for your app
 
+- __😎 Request Caching:__ - Blazze handles caching automatically in both Production and Dev Environments. In production it is obviously necessary to optimize large computations, however request caching is taken care of in dev mode as well by Blazze to provide a smooth developer experience, there is no need to revalidate the cache manually everything is handled by Blazze under the hood.
+  
+- __🏎️ Powered by SWC:__ - Blazze leavrages Rust-based tool: [Speedy Web Compiler](https://swc.rs/) to transiple Typescript files, so there negligible waiting time after file changes.
+  
+- __🐣 Easy Setup:__ - Hit `npx blazz-init` to start building your projects, you'll be asked a few questions for configuring Blazze & that's it Blazze will setup the project for you.
+  
+- __💪 TypeScript:__ - Out of the box TS support, no configurations and environment setup, just get started directly.
+  
+- __📂 Directory based Routing:__ - Keep the logic separated without any setup. Routes are based on the directory structure. ex: you will create a dir `user` inside of which you can add your logic for various request methods viz: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
+
+- __🚀 Fast & Robust:__ - Built on top of [Express JS](https://expressjs.com/) and [Helmet JS](https://helmetjs.github.io/), security and efficiency by default.
+  
+- __💫 No Boiler Plate Code:__ - Install init and start, Nothing else 🚀
+  
+- __🔥 Build Opimization:__ - Makes a single optimized Expressjs bundle for your complete app
+  
 ## How to start ? 
 
 - Install blazze `npm i blazze@latest`
@@ -34,11 +46,16 @@ A light-weight express framework to write typesafe API's with zero configuration
   <img width="" alt="Screenshot 2024-01-11 222945" src="https://github.com/Axnjr/Blazze.js/assets/111436589/c9f09ffe-953e-43a5-bd52-ef2f8ee376e0">
 
 - Create your API routes in the root-endpoint directory 
-- Each route can have 5 http method files viz: GET, POST, PUT, PATCH, DELETE
-- Each files handles specific API request methods
+- Each route can have 5 HTTP method files viz: GET, POST, PUT, PATCH, DELETE
+- Each file handles specific API request methods
 - You need to export a default normal function from each file
 - These functions get Express Request and Response objects as parameters
 - For nested routes use "@" symbol ex: new/subs/ppl will be -> new@subs@ppl which will have its respective logic
-- This is to avoid deep recursive file watching and being more performent for the system
-- Dynamic routes start with a underscore "_" ex: api/v1/_users 
+- This is to avoid deep recursive file watching and being more performant for the system
+- Dynamic routes start with an underscore "_" ex: api/v1/_users 
 - That's it you are ready to blazze ...
+
+## Contribute to Blazze
+Read the [Contribution guidlines](https://github.com/Axnjr/Blazze.js/blob/main/contributing.md) to begin.
+
+## Give Blazze a Star ❤️⭐

contributing.md

@@ -2,27 +2,27 @@
 
 👋 Thank you for considering contributing to Blazze.js! I appreciate your interest in making my framework even better. Please take a moment to review this document to understand how you can contribute to Blazze.js.
 
-## Getting Started
+## Developing
 
 Before you start contributing, make sure you have [Node.js](https://nodejs.org/) installed on your machine.
 
-1. Fork the Blazze.js repository on GitHub.
-2. Clone your forked repository to your local machine.
+1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
 
-```bash
-git clone https://github.com/Axnjr/Blazze.js.git
-```
-
-3. Navigate to the project directory.
+2. Create a new branch:
+   ```
+   git checkout -b feat/MY_BRANCH_NAME
+   ```
+   > Use a descriptive and meaningful name for the branch that reflects the purpose of your contribution.
 
-```bash
-cd Blazze.js
-```
+3. Install dependencies.
+    ```bash
+    npm install
+    ```
 
-4. Install dependencies.
-```bash
-npm install
-```
+4. Start developing
+   ```bash
+   node index.js or npm run dev 
+   ```
 
 ## Making Changes
 
@@ -49,6 +49,29 @@ git push origin feature-branch
 
 5. Open a pull request on the main Blazze.js repository.
 
+## Commit Guidelines
+
+- We encourage [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format for your commit messages.
+- Keep your commit messages concise, clear, and descriptive.
+- Make sure to include a brief summary of the changes made in the commit.
+
+```
+The commit message should be structured as follows:
+
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+
+```
+Example Commit Message:
+
+```
+feat(cache): Add new caching system
+```
+
+
 ## Coding Standards
 
 - Follow the JavaScript Standard Style.