Technoworld: The one of a kind e-commerce web application

📋Table of Contents

1. Introduction
2. Getting Started
   • Prerequisites
   • Installation Instructions
   • Configuration Steps
3. Useful Commands
4. Usage
5. Features
6. Technologies Used
7. Contributing
8. License

🚀 1. Introduction

Welcome to Tecnhoworld, your ultimate destination for all your tech needs! Tecnhoworld is an innovative e-commerce application designed to provide users with a seamless shopping experience for a wide range of technological products. Whether you're searching for the latest gadgets, electronics, or accessories, Tecnhoworld has you covered.

🎬 2. Getting Started

Prerequisites:

Before installing Tecnhoworld, make sure you have the following prerequisites installed:

• Visual Studio Code - https://code.visualstudio.com/download
• Node.js (version 20.9.0 or higher), including the npm package manager- https://nodejs.org/en/download

Get up and running with Tecnhoworld in no time with these simple steps:

Installation Instructions:

To install Tecnhoworld, follow these steps:

1. Clone the repository from GitHub:

   git clone https://github.com/Dimitar28/Technoworld.git
   

2. Open Visual Studio Code and open a new terminal (either using Ctrl + Shift + ` or through the VS Code UI)

3. Navigate to the project directory:

   cd tecnhoworld
   

4. Install dependencies using your preferred package manager:

   npm install
   

Configuration Steps:

Once the dependencies are installed, follow these configuration steps:

1. Configure the database connection settings in the .env file.
2. Customize any other settings or configurations as needed.

🧞 3. Useful Commands

All commands are run from the root of the project, from an already opened terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI

🪧 4. Usage

Learn how to use Tecnhoworld for your shopping needs with the following guidelines:

Basic User Usage Guide:

• User Registration: Sign up for a Tecnhoworld account to access all features.
• Browsing Products: Explore the wide range of tech products available on Tecnhoworld.
• Adding to Cart: Add desired items to your shopping cart for future purchase.
• Participaing in auctions: View and participate in special auctions each week.
• Checkout Process: Complete the checkout process to place an order.
• Managing Orders: View and manage your orders from the user dashboard.
• Account Settings: Customize your profile and preferences in the account settings section.

Basic Admin Usage Guide:

Includes all of the above and the following:

• Managing Products: As an admin, use the admin dashboard to add, view, edit or delete products from the catalog.
• Processing Orders: Fulfill customer orders efficiently using the order management system.
• Managing Inventory: Keep track of product availability, stock levels and ratings.
• Managing Auctions: As an admin, use the admin panel to create, view and manage auctions.

🥳 5. Features

Discover the key features that Tecnhoworld has to offer:

• Product Catalog: Browse through a vast catalog of tech products, including gadgets, electronics, and accessories.
• User Authentication: Securely register, login, and manage your account for a personalized shopping experience.
• Search Functionality: Quickly find specific products using the search bar with advanced filtering options.
• Shopping Cart: Add items to your cart and easily manage your shopping list before checkout.
• Order Management: Track your orders, view order history, and manage order status from your user dashboard.
• Admin Dashboard: Access an intuitive admin dashboard to manage products, orders, auctions and user accounts efficiently.
• Responsive Design: Enjoy a seamless shopping experience across devices with a responsive and mobile-friendly design.
• Secure Transactions: Ensure secure transactions with built-in encryption and payment gateway integration.
• Auction Participation: Participate in auctions to bid on and win exclusive tech products at competitive prices.
• Customization Options: Personalize your experience by customizing the overall theme, currency, and language settings.
• Chatbot Integration: Interact with a customer support chatbot for instant assistance and support.

🧑‍💻 6. Technologies Used

Tecnhoworld utilizes a variety of technologies and Node.js packages to power its functionality:

Core Technologies:

• MySQL: Relational database management system used for storing and managing application data.
• HTML: Markup language used for creating the structure and content of web pages.
• CSS: Style sheet language used for styling the presentation of web pages.
• TypeScript: Superset of JavaScript that adds static typing and other advanced features for building scalable applications.
• Astro: Static site generator for building modern websites with dynamic components.
• Node.js: JavaScript runtime environment used for building scalable and high-performance server-side applications.
• Express.js: Web application framework for Node.js used for building robust APIs and web applications.

Node.js Packages:

• bcrypt: Library for hashing passwords securely, commonly used for user authentication.
• fuse.js: Lightweight fuzzy-search library for efficiently searching through collections of data.
• OpenAI: Library or API used for integrating artificial intelligence and natural language processing capabilities into applications.
• Sequelize: A promise-based Node.js ORM tool for Postgres, MySQL, MariaDB etc. It features solid transaction support, relations, eager and lazy loading and more.
• And more

🧑‍🤝‍🧑 7. Contributing

We welcome contributions from the community to enhance Tecnhoworld and make it even better! Whether you're a developer, designer, or enthusiast, there are several ways you can contribute:

Reporting Issues:

If you encounter any bugs, glitches, or inconsistencies while using Tecnhoworld, please report them by opening an issue on our GitHub repository. Be sure to include detailed information about the issue and steps to reproduce it.

Contributing Code:

We appreciate contributions in the form of code enhancements, new features, or bug fixes. To contribute code, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure they adhere to our coding standards.
4. Test your changes thoroughly.
5. Submit a pull request with a clear description of your changes.

Providing Feedback:

Your feedback helps us understand the needs and preferences of our users. Whether it's a feature request, suggestion for improvement, or general feedback, feel free to share your thoughts with us through GitHub issues or our contact channels.

📜 8. License

Tecnhoworld is licensed under the MIT License.