Project Pathways

Description

Pathways is a microservice which companies can use to empower employees to manage their goals using tags and filtering, and facilitates communication between employees and their managers through a comment system. Pathways is designed with companies in mind - the primary users of the application would be the employees of UKG’s customers.

Getting started

Pulling from github

git clone https://github.com/paschalc24/SCRUMberlandFarms.git

Installing prerequisite

frontend

Frontend dependencies requires only Nodejs, npm. After installing both, we can install the rest by doing:

cd client &
npm install
npm install --save react-spinners

Backend

Backend requires python3.10, psycopg2-binary, django, djangorestframework, django-cors-headers. Installation may differ between operating systems.

Running the website

frontend

To run frontend, you only need to run the below command.

cd client &
npm start 
# you may also run npm run build to create a production build and run using serve -s build

Backend

To run backend, you only need to run the below command

cd src/env/django/pathways &
python3 manage.py runserver
# if needed you may also run python3 manage.py makemigration and after python3 mangae.py migrate

API Documentation

-https://docs.google.com/document/d/19mWn-yQjW3YoaNqUtCMSuj-LGuHHBbMX34UwxqltkS0/edit?usp=sharing

Testing

The backend django test suite can be run using the following commands:

cd src/env/django/pathways &
python3 manage.py test
# the tests will also automatically run on push and merge to main