Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.43 KB

README.md

File metadata and controls

64 lines (48 loc) · 2.43 KB
Raw

Finals-PHP-Ecommerce

A simple Ecommerce Application in PHP

Contribution Guidelines

  • Have a Look at the project structure and folder overview below to understand where to store/upload your contribution
    • Task Folder Naming Convention : task-n-taskname.(n is the task number) ex: task-1-UI/UX, task-2-Testing etc.
    • Create a README.md with a table containing information table about all contributions for the task.
  • Please restrict yourself from creating unnessesary folders other than in 'tasks' folder (as above mentioned naming convention) to avoid confusion.

Project Structure

├── LICENSE
├── README.md          <- The top-level README for developers/collaborators using this project.
│
├── reports            <- Folder containing the final reports/results of this project
│   └── README.md      <- Details about final reports and analysis
│ 
│  
├── src                <- Source code folder for this project
    │
    ├── deployment     <- Deployment source code
    │
    ├── docs           <- Folder for Task documentations, and task Workflow Documents and Diagrams.
    │
    ├── references     <- Data dictionaries, manuals, and all other explanatory references used
    │
    ├── tasks          <- Master folder for all individual task folders

Folder Overview

  • Reports - Folder to store all Final Reports of this project
  • Docs - Folder for Task documentations, Meeting Presentations and task Workflow Documents and Diagrams.
  • References - Folder to store any referenced code/research papers and other useful documents used for this project
  • Tasks - Master folder for all tasks
    • All Task Folder names should follow specific naming convention
    • All Task folder names should be in chronologial order (from 1 to n)
    • All Task folders should have a README.md file with task Details and task goals along with an info table containing all code files with their links and information
    • Update the task-table whenever a task is created and explain the purpose and goals of the task to others.

Project Setup

Open the Command line or Terminal

  • Clone the repository
git clone https://github.com/Finals-PHP-Ecommerce.git
  • Move to the folder
cd Finals-PHP-Ecommerce
  • To open with VSCode
code .