E-commerce website for Vendors and Customers.
Here are instructions in getting your code up and running on your own system.
To run this project yolu woud need to Download and install varoius appications and packages
To download the application use the official Virtual Studio code website and choose your operating system whether it be Windows, Mac or Linux. Once downloaded, please install. The link below:
https://code.visualstudio.com/download
There are two options for downloading this project from Github
Follow this link for download:
https://github.com/Ayobamidele/Hustle-24/tree/main
Then follow these instructions:
Navigate to the “<>Code” tab.
Click on the “Code” button on the right. A dropdown should appear.
In the “Clone” menu, under the “HTTPS” tab, click on “Download ZIP”
To clone the project you would need to have installed Git
At the heart of GitHub is the open source Version Control System called Git. Git is responsible for everything that happens locally on your computer related to GitHub.
Let's verify that Git is not already installed on your machine. Open Terminal if you are on a Mac or PowerShell if you are on a Windows machine and type:
git --version
After running the code in Terminal, you should see something like:
git version 2.22.0.windows.1
If you don't have Git installed, download and install the latest version of Git. at this link: https://git-scm.com/downloads
Git uses a username to associate commits with an identity, that is, every time you upload your code to GitHub that git username will be used to identify you as the author of the code uploaded within the repository on GitHub .
💡 The Git username is different from the GitHub username.
To configure your Git username for all your repositories on your computer, do:
git config --global user.name "Ada Lovelace"
git config --global user.name
> Ada Lovelace
Then follow these instructions to use this command to clone:
Follow this link: https://github.com/Ayobamidele/Hustle-24/tree/main
Navigate to the “<>Code” tab.
Click on the “Code” button on the right. A dropdown should appear.
In the “Clone” menu, under the “HTTPS” tab, click on the copy clipboard icon
Open your terminal and type theis command git clone
Then paste into the termial and click enter. (It should then look like the command below)
git clone https://github.com/Ayobamidele/Hustle-24.git
You must have installed Python and Django to run the project and most importantly Pip for the next instruction and as said earlier a virtual environment.
Need help with the installtion the follow the instructions below
Need help installing Python, follow the instructions below:
If you have not yet installed Python on your Windows OS, then download and install the latest Python3 installer from Python Downloads Page
Once Python is installed, you should be able to open a command window, type python
, hit ENTER, and see a Python prompt opened. Type quit()
to exit it. You should also be able to run the command pip
and see its options. If both of these work, then you are ready to go.
python
or pip
from a command prompt, you may need to add the Python installation directory path to the Windows PATH variablepython.exe
file
C:\Python27
C:\Users\<USERNAME>\AppData\Local\Programs\Python\Python37
PYTHON_HOME
;%PYTHON_HOME%\;%PYTHON_HOME%;%PYTHON_HOME%\Scripts\
to the end of it.python
and pip
MacOS comes with a native version of Python. As of this writing, it comes with a version of Python2, which has been deprecated. In order to use most modern Python applications, you need to install Python3. Python2 and Python3 can coexist on the same machine without problems, and for MacOS it is in fact necessary for this to happen, since MacOS continues to rely on Python2 for some functionality.
There are a couple of ways we can install Python3 on your MacOS operating system:
.command
files in it
Install Certificates.command
file and the Update Shell Profile.command
file to run each of thempython3
to enter the Python interactive command line. Issue the command quit()
to exit. Also make sure PIP (the Python package manager) is installed by issuing the command pip3 -V
. It should display the current version of PIP as well as Python (which should be some release of Python3).Homebrew is a MacOS Linux-like package manager. Walk through the below steps to install Homebrew and an updated Python interpreter along with it.
xcode-select --install
. This will open a window. Click 'Get Xcode' and install it from the app store./bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install python
python3
, hit ENTER, and see a Python 3.X.X prompt opened. Type quit()
to exit it. You should also be able to run the command pip3
and see its options. If both of these work, then you are ready to go.
sudo apt install -y python3-pip
sudo apt update
sudo apt install -y python3-pip
RHEL (CentOS) distributions usually need PIP
sudo yum install -y epel-release
sudo yum install -y python3-pip
Follow the instructions found below to install pip depending on your operating system:
$ python -m ensurepip --upgrade
C:> py -m ensurepip --upgrade
Django 3.2 will be installed in the requirements.txt when the pip command in package dependencies is run. If you want to install the latest version run this command
python -m pip install Django
After cloning or downloading the repo I highly recommend creating a virtual environment to avoid any errors. Follow the instructions found in the link below to create a virtual environment to run the project and install packages:
https://gist.github.com/MichaelCurrin/3a4d14ba1763b4d6a1884f56a01412b7
After completing this part follow the next instructions.
To run the program you'll need to download some packages first. Run this command to install the packages in requirements.txt:
pip install -r requirements.txt
Now run this command to run the project after succesfully installing the package dependencies.
python manage.py runserver
You should then be able to view the project from the browser using the link provided in the terminal
During the creation of this project python 3.10 was available but python 3.8 was used to avoid any issues with support. All versions 3.+ should work.
Testing the project is still in development using pytest and coverage package to ensure all functions are up and running to avoid by error and early detection. Testing will be released soon.
The database allows for multiple products to have multiple attributes. Allowing for a product to have different attributes. Products can have categories, picture, quantity, price and discount price by default. Products can also be deactivated or activated to display when needed. The website loads products from a SQLite database and displays them. Users can select display products in a single category - which are set active in the database. Users can click on any product to get more information including pricing and other available details. Users can select items and add them to their shopping cart. There they can checkout having the options to pay with Paypal or email. If you don't want to buy yet, you could save to your wishlist for later
User payment address and card details is saved on the site for fast checkout. Users have the options to pay with:
Superusers can access the admin page. The page is enabeled with filtering and ordering, so searching through various data objects is fast and easy.
Users have easy access to the login and register page and if any issue with their password they have the option to reset it with their email. Some personal details can also be added.
Note: Once users register their account, the email won't be removed from the database if you try to delete the account. Also after registering you can't change the email used to register.