QuicklyKit is an Express.js application offering a suite of general-purpose tools for everyday tasks, including a QR Code Generator, URL Shortener, and more. Built with Express.js, MongoDB, and EJS, it emphasizes simplicity and functionality for routine activities. The website is only created for educational purpose.
- QR Code Generator: Create QR codes for URLs or text.
- URL Shortener: Shorten long URLs for easy sharing.
- Color Picker: Helps you pick colors and their hex code.
- Ip finder: Finds your IP address details.
- Text to speech: A interactive tool to convert your text into sound.
- BMI calculator: Helps to find your current bmi index.
- Additional tools to enhance daily productivity.
QuicklyKit/
├── controllers/ # Application logic.
├── middleware/ # Contains user defined middlewares.
├── models/ # Database schemas (MongoDB).
├── routes/ # Express route definitions/.
├── views/ # EJS templates for the frontend.
├── views/tools/ # EJS templates for the tools.
├── public/ # Static assets (CSS, JS, images).
├── app.js # Main application entry point.
├── package.json # Project metadata and dependencies.
└── README.md # Project documentation.
- Node.js: Ensure Node.js is installed on your machine. Download Node.js
- MongoDB: Set up a MongoDB database. Install MongoDB
-
Clone the Repository:
>> git clone https://github.com/aadi1335/QuicklyKit.git >> cd QuicklyKit
-
Install Dependencies:
>> npm install
-
Start the Application:
>> npm start
The application will run at
http://localhost:3000/Login
. -
Start application under development server
>> npm run start:dev
The application will run at
http://localhost:3000/Login
.
- Navigate to
http://localhost:3000/Login
in your browser. - Access the tools via the navigation menu.
- Utilize the QR Code Generator, URL Shortener, and other available utilities.
Contributions are welcome! Please fork the repository and submit a pull request with your enhancements.
This project is licensed under the MIT License. See the LICENSE file for details.
This `README.md` provides an overview of QuicklyKit, including its features, project structure, installation steps, usage instructions, and contribution guidelines. Adjust the content as needed to accurately reflect your project's specifics.