Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 11 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,8 @@
This file explains this project.
It contains information that is commonly required to understand what this project is about.

Note 1: Any line that has **[[remove]]** after it should be removed from your file. **[[remove]]**

Note 2: Any line that has **[[replace]]** after it should be replaced with your own information. **[[remove]]**

# Project Name [[replace]]
Project description goes here... **[[replace]]**
# Tallah Store
This project implements a simple clothing store called the Tallah Store. The website is a simple e-commerce website that allows admins to create products and classify them into categories. And it allows customers to make orders

# Table of contents
* [Project Setup](#project-setup)
Expand All @@ -22,23 +18,20 @@ In this section, the key points about technologies used in the project are menti

### Technologies and Dependencies

Describe any prerequisites, frameworks, libraries, OS version, etc., needed before installing program. **[[remove]]**

For example: **[[remove]]**
* Project is created with:
* Laravel: v9. **[[replace]]**
* OS: Ubuntu 22.04. **[[replace]]**
* add any extra libraries you use here if there is any **[[remove]]**
* Laravel: v8.x
* Windows 10, v22H2
* Bootstrap: v5.2.2
* Laravel Breeze: vv1.14.2

### Installing & Executing program
To run this project locally, just download a copy of the code and run the following commands:

* How to run your project on a local environment **[[replace]]**
* Use Step-by-step bullets to list the steps, and code block for commands, for example: **[[replace and replace code block below]]**
```
$ cd code
$ cd Ecommerce-Taghrid- Edraak # this is the project folder you downloaded
$ npm install
$ npm run dev
```
$ composer install
$ php artisan migrate
$ php artisan serve

## Project Requirements
In this section, a list of all the requirements/features of the project are presented.
Expand Down