Business-Applications-Development

This is a repository for the files in fulfillment of the MSYS 42 project which is CGST Order Inventory Management System.

It is used for managing steel inventory as well as managing orders concerning these inventory.

The real-world client of this project was a manager from China Global Steel Corporation.

To obtain the settings.py and Django Secret Key, message Gael Estrera.

User Software Manual: Link

Systems Design and Development

The Software System was designed by Chan Hyun, Gael Estrera, Jem Flores, Faustin Pua, and Alexis Miner.

This Software System was developed by Gael Estrera by following the Model-View-Controller (MVC) architecture.

Tech Stack used

Django
This framework utilizes Python and is used for both front-end and back-end. For this project, it is heavily used for back-end computing especially in session data, Model data analysis, and model instance creations.

Javascript
Plain Javascript will be used for client-side rendering of dynamic HTML changes such as dropdown quantity and total cost. This will also be used for User Interface and User experience.

SQL
SQL is used for creating and managing queries for functional back-end algorithms.

Supported Platforms and Browsers

The application can be used in Windows 10+ and MacOS 10.14.16 (Mojave)
Supported browsers are Google Chrome and Safari

Database Architecture

Install MySQL

Install MySQL for MacOS:
https://dev.mysql.com/doc/mysql-macos-excerpt/5.7/en/macos-installation.html

Install MySQL for Windows:
https://dev.mysql.com/downloads/installer/

Afterwards, setup a permanent environment path for MySQL.

Install Python

Install Python 3.9.5 in Windows or Mac.

Install Python for MacOS:
https://www.dataquest.io/blog/installing-python-on-mac/

Install Python for Windows:
https://www.tomshardware.com/how-to/install-python-on-windows-10-and-11

Activate Python Virtual Environment

The purpose of a Python virtual environment is to create an isolated virtual space where you could freely
install packages and depencies for a certain project without worrying if these packages and depencies will
conflict with your global packages!

Open up the directory of the project, but be sure you're outside of the "SalesApp" directory. Once you're in this directory, type:

For MacOS:

source Steel/bin/activate

The Python Virtual Environment for MacOS will then be activated! You can now run the server.

For Windows:

python3 -m venv Steel

Running the Server

Enter the directory of the virtual environment folder that you've created.
Activate the Python virtual environment:

For MacOS devices:

source bin/activate 

For Windows devices greater than 7 and 8:

Scripts/activate

After activation, move out of the virtual environment directory, and run the commond below to install packages dedicated to your virtual environment:

pip install -r requirements.txt 

Within the second SalesApp directory, create a password.txt file containing the password of the MySQL Database that you created. Type the password in the first line of the password.txt file with no spaces.

Once Django is installed in the machine, go within the "SalesApp" directory and type:

python3 manage.py runserver