Back to projects
Keens Web Application

Keens Web Application

Madhuka Malshan / February 3, 2025

Introduction

This is the official web application for Keens. This document provides information on how to set up, run, and maintain the application, including details about its structure and the technologies used.

Tech Stack

The application is built using the following technologies:

  • Frontend: HTML, CSS, JavaScript, Bootstrap
  • Backend: PHP
  • Database: MySQL
  • Version Control: Git

Project Structure

The project consists of the following main parts:

  • Frontend: Contains all HTML, CSS, and JavaScript files for UI/UX.
  • Backend: PHP scripts handling business logic and database interactions.
  • Database: MySQL database storing user data, transactions, and other relevant information.
  • Config Files: Includes environment settings and database configurations.

Setup Instructions

Prerequisites

Ensure you have the following installed:

  • PHP
  • MySQL
  • Apache Server (XAMPP, WAMP, or LAMP)
  • Git

Installation Steps

  1. Download the Repository:
  2. cd KeensEcom
  3. Move Files to Server Directory:
    • Copy the project folder to the server root directory (e.g., htdocs for XAMPP).
  4. Set Up the Database:
    • Open phpMyAdmin and create a new database.
    • Import the provided SQL file (database/ast.sql) to set up tables.
    • Update database connection details in components/connect.php.
  5. Run the Application:
    • Start Apache and MySQL from XAMPP/WAMP.
    • Open a web browser and visit http://localhost/ast.

Deployment

To deploy the application, follow these steps:

  • Upload Project Files: Upload project files to a web hosting server.
  • Set Up the MySQL Database: Set up the MySQL database on the hosting server and import the SQL file.
  • Update Database Credentials: Update connect.php with the live database credentials.

Contribution Guidelines

  • Fork the Repository: Fork the repository and create a new branch for features/bug fixes.
  • Follow Best Practices: Follow coding best practices and maintain clean documentation.
  • Submit a Pull Request: Submit a pull request for review.