From fce4cd5a012bd7edbed34f928d99953669f4a4ef Mon Sep 17 00:00:00 2001 From: Your Name Date: Wed, 27 Mar 2024 21:33:35 -0700 Subject: [PATCH 1/2] update readme file --- databes_stf.sql => Database/schema.sql | 0 README.md | 81 ++++++++++++++++ readme.rst | 122 ++++++++++++------------- 3 files changed, 141 insertions(+), 62 deletions(-) rename databes_stf.sql => Database/schema.sql (100%) create mode 100644 README.md diff --git a/databes_stf.sql b/Database/schema.sql similarity index 100% rename from databes_stf.sql rename to Database/schema.sql diff --git a/README.md b/README.md new file mode 100644 index 0000000..236ccff --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# CI-SHOP + +Welcome to the documentation for our E-commerce web app project developed using CodeIgniter framework v.3 and HMVC Extension. This project aims to provide a comprehensive solution for building an online store,following best HMVC practices. leveraging the power and flexibility of CodeIgniter along with the modular structure facilitated by HMVC. + +## About The Project + +This E-Commerce Web App is designed to provide a seamless shopping experience, featuring a user-friendly interface, secure payment gateways, and an intuitive admin panel for easy management of products, orders, and customers. +I use two free HTML template. +- [Freak – Free Boutique eCommerce Template](https://freethemescloud.com/item/freak-free-boutique-ecommerce-template/) for Public Template and +- [Bootstrap Metro Dashboard](http://jiji262.github.io/Bootstrap_Metro_Dashboard/) for admin Template. + +## Features +- **User Authentication:** Secure user authentication system for **customers** and **administrators**. +- **Product Management:** Easily manage products, including adding, editing, and removing them. +- **Order Management:** Efficient order processing system for managing customer orders. +- **Shopping Cart:** Seamless shopping experience with a fully functional shopping cart. +- **Payment Integration:** Integration with Paypal popular payment gateways for secure transactions. +- **Responsive Design:** Responsive design ensures optimal viewing experience across devices. + + +## Getting Started + +### Prerequisites + +- PHP version 5.6 or newer is recommended. +- MySQL 5.6 or higher +- Composer + +### Installation + +1. Clone the reporepositories + ```sh + git clone https://github.com/kingashuu/E-commerce-Project-in-ci.git + +2. Rename cloned folder to your Project-Name +*for example like `"cishop"` * + +3. Import the database schema located in +`database/schema.sql` +rename schema.sql to `cishop.sql` +4. Configure your environment and config.php file with your database credentials, write your Project-Name in config file + +``` $config['base_url'] = http://localhost/Project-Name/'; ``` + +### Usage +To start the application, navigate to the project directory and open in code editer: + +Now, access the application at +`http://localhost/'Project-Name'.` + +to access administrators + +`http://localhost/'Project-Name'/admin_login` + +**username**:admin +**password**:adminpass + +### Contributing🚀 +Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. + +1. Fork the Project +2. Create your Feature Branch (git checkout -b feature/AmazingFeature) +3. Commit your Changes (git commit -m 'Add some AmazingFeature') +4. Push to the Branch (git push origin feature/AmazingFeature) +5. Open a Pull Request + +### License +Distributed under the MIT License. See LICENSE for more information. + +### Contact +- @ashuu4_real +- abekele76@gmail.com + + +### Acknowledgements +This project was based on +- A YouTube tutorial by [David Connelly](https://www.youtube.com/@davidconnelly/). +- CodeIgniter 3 Framework +- wiredesignz codeigniter modular extensions +#### 👍 Star the Project +If you found this project useful, please consider giving it a star🌟. Your support is appreciated diff --git a/readme.rst b/readme.rst index 53fb1f3..236ccff 100644 --- a/readme.rst +++ b/readme.rst @@ -1,83 +1,81 @@ -################### -This is E-commerce web app project using Codeigniter framework and HMVC Extension -################### +# CI-SHOP -********************** -ADMIN -********************** -localhost/cishop/admin_login +Welcome to the documentation for our E-commerce web app project developed using CodeIgniter framework v.3 and HMVC Extension. This project aims to provide a comprehensive solution for building an online store,following best HMVC practices. leveraging the power and flexibility of CodeIgniter along with the modular structure facilitated by HMVC. -username:admin +## About The Project -password;adminpass +This E-Commerce Web App is designed to provide a seamless shopping experience, featuring a user-friendly interface, secure payment gateways, and an intuitive admin panel for easy management of products, orders, and customers. +I use two free HTML template. +- [Freak – Free Boutique eCommerce Template](https://freethemescloud.com/item/freak-free-boutique-ecommerce-template/) for Public Template and +- [Bootstrap Metro Dashboard](http://jiji262.github.io/Bootstrap_Metro_Dashboard/) for admin Template. -################### -What is CodeIgniter -################### +## Features +- **User Authentication:** Secure user authentication system for **customers** and **administrators**. +- **Product Management:** Easily manage products, including adding, editing, and removing them. +- **Order Management:** Efficient order processing system for managing customer orders. +- **Shopping Cart:** Seamless shopping experience with a fully functional shopping cart. +- **Payment Integration:** Integration with Paypal popular payment gateways for secure transactions. +- **Responsive Design:** Responsive design ensures optimal viewing experience across devices. -CodeIgniter is an Application Development Framework - a toolkit - for people -who build web sites using PHP. Its goal is to enable you to develop projects -much faster than you could if you were writing code from scratch, by providing -a rich set of libraries for commonly needed tasks, as well as a simple -interface and logical structure to access these libraries. CodeIgniter lets -you creatively focus on your project by minimizing the amount of code needed -for a given task. -******************* -Release Information -******************* +## Getting Started -This repo contains in-development code for future releases. To download the -latest stable release please visit the `CodeIgniter Downloads -`_ page. +### Prerequisites -************************** -Changelog and New Features -************************** +- PHP version 5.6 or newer is recommended. +- MySQL 5.6 or higher +- Composer -You can find a list of all changes for each release in the `user -guide change log `_. +### Installation -******************* -Server Requirements -******************* +1. Clone the reporepositories + ```sh + git clone https://github.com/kingashuu/E-commerce-Project-in-ci.git + +2. Rename cloned folder to your Project-Name +*for example like `"cishop"` * -PHP version 5.6 or newer is recommended. +3. Import the database schema located in +`database/schema.sql` +rename schema.sql to `cishop.sql` +4. Configure your environment and config.php file with your database credentials, write your Project-Name in config file -It should work on 5.3.7 as well, but we strongly advise you NOT to run -such old versions of PHP, because of potential security and performance -issues, as well as missing features. +``` $config['base_url'] = http://localhost/Project-Name/'; ``` -************ -Installation -************ +### Usage +To start the application, navigate to the project directory and open in code editer: -Please see the `installation section `_ -of the CodeIgniter User Guide. +Now, access the application at +`http://localhost/'Project-Name'.` -******* -License -******* +to access administrators -Please see the `license -agreement `_. +`http://localhost/'Project-Name'/admin_login` -********* -Resources -********* +**username**:admin +**password**:adminpass -- `User Guide `_ -- `Language File Translations `_ -- `Community Forums `_ -- `Community Wiki `_ -- `Community Slack Channel `_ +### Contributing🚀 +Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. -Report security issues to our `Security Panel `_ -or via our `page on HackerOne `_, thank you. +1. Fork the Project +2. Create your Feature Branch (git checkout -b feature/AmazingFeature) +3. Commit your Changes (git commit -m 'Add some AmazingFeature') +4. Push to the Branch (git push origin feature/AmazingFeature) +5. Open a Pull Request -*************** -Acknowledgement -*************** +### License +Distributed under the MIT License. See LICENSE for more information. -The CodeIgniter team would like to thank EllisLab, all the -contributors to the CodeIgniter project and you, the CodeIgniter user. +### Contact +- @ashuu4_real +- abekele76@gmail.com + + +### Acknowledgements +This project was based on +- A YouTube tutorial by [David Connelly](https://www.youtube.com/@davidconnelly/). +- CodeIgniter 3 Framework +- wiredesignz codeigniter modular extensions +#### 👍 Star the Project +If you found this project useful, please consider giving it a star🌟. Your support is appreciated From ecdcb5b9ca9ccf28fd77523ba8eb71e770dc787a Mon Sep 17 00:00:00 2001 From: Ashenafi Bekele <48837802+kingashuu@users.noreply.github.com> Date: Wed, 27 Mar 2024 12:35:36 -0700 Subject: [PATCH 2/2] Update README t.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 236ccff..36ac200 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# CI-SHOP +

+ CI-SHOP +

+ +# E-commerce web app project using PHP CodeIgniter framework v.3 and HMVC modular Extension Welcome to the documentation for our E-commerce web app project developed using CodeIgniter framework v.3 and HMVC Extension. This project aims to provide a comprehensive solution for building an online store,following best HMVC practices. leveraging the power and flexibility of CodeIgniter along with the modular structure facilitated by HMVC.