Package: django-steamcleancrm
Steam Clean CRMAn intuitive client relationship management tool for small businesses in the service industryReport a Bug·Request a FeatureTable of ContentsAbout The ProjectBuilt WithGetting StartedPrerequisitesInstall Using PipCloning the Github RepoUsageData PipelineRoadmapContributingLicenseContactAcknowledgmentsAbout The ProjectKeep track of leads, staff, work orders, and a gallery of images for each work orderLeads hold client contact information and can have any number of associated work ordersWork orders can have any number of associated images and assigned staff membersStaff members are assigned groups based on their role and have permissions based on their groupStaff members can be assigned to work orders, cancel or submit completed work orders, upload images, etc.Please see the roadmap below for features currently under development.(back to top)Built WithDjango(back to top)Getting StartedYou can install this project usingpipor by cloning the github repositoryPrerequisitesIf you already have a virtual environment and django project set up, you can skip ahead to the next step.Start a new virtual environment in your project directory or wherever you keep them$python3-mvenvenvActivate your virtual environment$source/path/to/env/bin/activateInside of your environment, install Django and start a new project$pipinstalldjango$django-adminstartprojectsteamcleancrmInstall using pipTake a look at the prerequisites for instructions on setting up your virtual environment and django project if you haven't alreadyInside of your environment, run the command to install the package with pip$pipinstalldjango-steamcleancrm==0.3Add the package to the Installed Apps section of your settings.py fileINSTALLED_APPS=[...'crm.apps.CrmConfig']Cloning the github repoActivate your virtual environment and navigate to the directory you want to clone the project inClone the repo$gitclonehttps://github.com/JohnGWebDev/steamcleaning.gitInstall the project dependencies from .requirements$pipinstall-r.requirementsCreate a .env file in the project's root directory for your environment variablesGenerate a new secret key for your django settings with the following command$python-c"import secrets; print(secrets.token_urlsafe())"Copy the new token and paste it into your .env file, for example:SECRET_KEY=OZvhK2ApBiLy4uXf91MIm2RNDK3b2dDp0UV7gAL0tBM(back to top)UsageThe project requirements were a lightweight client relationship management tool that can also store any number of images associated with a specific work order with room for future development.Groups and PermissionsThere are three groups a staff member can be assigned to:RepresentativeCreate and update leadsCreate, update and cancel work ordersTechnicianCreate and update leadsCreate, update, cancel and complete work ordersUpload and delete imagesManagerCreate and update leadsCreate, update, and approve canceled/completed work ordersUpload and delete imagesAssign technicians to work ordersData PipelineAdd a lead manuallyLeads can be added manually by a representative from incoming calls or automatically from a cross-origin POST request such as a contact formStores client contact informationLeads can have any number of related work ordersOpen a work order relating to the leadStores description of the work to be perform, appointment dates, assigned Technicians, associated images, estimated total, etc.Manager or Admin assigns a technician to the work orderAny number of Technicians can be assigned to a work orderWork is performedTechnicians can update work orders if needed on the jobTechnician uploads images to work order and marks it completeAny number of images can be uploaded to a work orderA work order can also be canceled at any timeWhen a Technician marks a work order canceled or complete, it is submitted for review by a Manager or AdminAutomated email survey ( under development )Survey is sent to client one work order is verified complete by a Manager/AdminTechnicians also fill out a survey after completing each work order(back to top)Roadmap[] Unit tests[] Create a survey for work order feedback from both clients and staff[] Analytics tools to track model metrics[] Create a new model, related to workorder, for work order descriptions to include more detailed information such as job type, price per square foot, etc.[] Automated email surveySee theopen issuesfor a full list of proposed features (and known issues).(back to top)ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull Request(back to top)LicenseDistributed under the MIT License. SeeLICENSE.txtfor more information.(back to top)Contactjohn1galiszewski@gmail.comLinkedInProject Link:https://github.com/JohnGWebDev/steamcleaning(back to top)Acknowledgments(back to top)