simple-stock-management | Server component of the Simple Stock Management stock | Business library

First, clone the repository to your file system. Ensure you have access to a current version of PostgreSQL (either locally installed, or remote). Ensure gunicorn is installed on your system. Create a system user under which to run the application (e.g. django). Recursively change ownership of the application directory and all its sub directories to that user, then switch to operate as that user. Change into the application's root directory. Install a python virtual environment on your system and make that your python source. Run pip3 install -r requirements.txt. Copy StockManagement/settings.DEFAULT.py to StockManagement/settings.py. Edit StockManagement/settings.py according to your environment. Be sure to add the URL of your frontend web client to the CORS_ORIGIN_WHITELIST list property. Create the PostgreSQL database and user, as defined. Create a directory named secret_key in the application's root directory and change its ownership to the application user (as created above). Change permissions on the secret_key directory so only the user running the application can read it, e.g.: chmod 0700 secret_key.
First, clone the repository to your file system.
Ensure you have access to a current version of PostgreSQL (either locally installed, or remote).
Ensure gunicorn is installed on your system.
Create a system user under which to run the application (e.g. django). Recursively change ownership of the application directory and all its sub directories to that user, then switch to operate as that user.
Change into the application's root directory.
Install a python virtual environment on your system and make that your python source.
Run pip3 install -r requirements.txt.
Copy StockManagement/settings.DEFAULT.py to StockManagement/settings.py.
Edit StockManagement/settings.py according to your environment. Be sure to add the URL of your frontend web client to the CORS_ORIGIN_WHITELIST list property.
Create the PostgreSQL database and user, as defined.
Create a directory named secret_key in the application's root directory and change its ownership to the application user (as created above).
Change permissions on the secret_key directory so only the user running the application can read it, e.g.: chmod 0700 secret_key.
As root (using sudo), create the log directory and file, e.g.: sudo mkdir -p /var/log/django; sudo touch /var/log/django/ssm.log
Change ownership of the log directory and its log file to the user running the app, e.g.: sudo chown -R django /var/log/django/
Create a systemd unit file to run the gunicorn service at /etc/systemd/system/gunicorn.service, then enable and start start the systemd service (details of how to do this is outwith the scope of this document, but if you need further advice feel free to get in touch).
Create a systemd unit file to run the django_q service (which manages long running operations, such as 'stock taking') at /etc/systemd/system/djangoq.service. Enable and start the systemd service (details of how to do this is outwith the scope of this document, but if you need further advice feel free to get in touch).
Install a web server (recommended Nginx) to operate as a reverse proxy and create an appropriate configuration file to connect to the unix socket created by gunicorn (as defined above). See the official Nginx and Django documentation for configuration examples.
Create the database tables, using the commands: python manage.py makemigrations; python manage.py makemigrations stock_control; python manage.py makemigrations accounts; python manage.py migrate.
If running for the first time (i.e. your persistent database folder is empty), define a superuser by issuing the following commands from the application's root directory python manage.py createsuperuser.
In the application's root directory, run python manage.py collectstatic, to add the static files to the appropriate directory (ensure the path to the static directory has been correctly configured in your web server configuration).
Now visit the app's administration area in your web browser (e.g. https://your.domain.tld/admin).
If running for the first time, create an administrators group and add a new user to it, as follows: Click add next to Groups in the Authentication & Authorization section. Name the new group administrators. Under Available permissions, scroll to the bottom and select all the spm_app permissions, clicking the arrow on the right to add these to the Chosen permissions pane (you may hold shift to select multiple at once). Once done, click Save. Create 2 additional user accounts; one for an application administrator (responsible for managing the warehouse), the other a regular user (a manager of a client shop). Ensure both users are assigned the staff status. Assign the administrator user to the administrators group, by: navigating to Home > Users > username; scrolling down to the Permissions section; selecting administrators from the Available groups box; and double-clicking it. This moves the group to the Chosen groups pane. Then, scroll to the bottom of the page and click Save.
If running for the first time, it's also necessary to initialise the provided frontend client by creating a single stock line from the admin dashboard (this only needs to be done if there are zero stock lines in the database - all subsequent stock items may be added directly from the provided frontend client by users with the administrators privilege). To do this: Navigate to Home > Stock_Control > Stock datas (accessible via the sidebar) Tap the Add Stock Data button (top right of the screen) Complete and submit the form.
Click LOG OUT (top right)
Login to the web client using the administrator user you created. Begin using Simple Stock Management.