Skip to content

Andersen-soft/MassCRM

Repository files navigation

logo

About us

Andersen CRM Marketing (MassCRM) is the system developed for working with potential clients in order to optimize the business processes of the marketing Department.

Our system let users:

  • create a database of your potential clients
  • easy access to clients data
  • using filters and sorts that help you find necessary clients data
  • import to the system data of your clients from the file
  • export your database to the file

We have collected key examples of usage. Please, explore the range of Andersen CRM Sales features by getting into User Guide. Download the file for more convenient reading.

Technologies

  • Laravel 7.0
  • PHP 7.4
  • Postgres 10.8
  • Redis
  • React 16.12
  • TS 3.7

Installation

  • To start deployment just clone the repo
  • After that modify .env files in directories masscrm_back and masscrm_front

Local build and deploy requires Linux OS, docker version >= 19.03.12 and docker-compose version >= 1.25.3 installed. Local build was tested at Ubuntu 18; Windows and MacOS are compatibility not guaranteed.

To start the application please use the following command:

bash up.sh

During the execution of this command, the following operations are performed:

  1. pull and up docker containers.
  2. install dependencies via Composer.
  3. migrations execution.
  4. start webSocket server.
  5. install dependencies via frontend

Generating key JWT and application. Creating list of users, contacts, companies and etc.

bash 1stlocalrun.sh

By default, the system has preset users for each role

Login Password Roles
David Lopez aZ12JeGbNq Admin
Paul Garcia q4puH6eJxW Manager
Jane Smith cZ4JJA8yHW NC1
Mike Jones V5eiayvzKj NC2

File down.sh gives you an ability to stop the project and change owner of logs folder to current user for cleaning. It destroys previously created docker network, so sudo password will be promted for it and owner changeng.

bash down.sh

Environments

  1. Frontend

  2. Backend

    Frontend

    • REACT_APP_MASS_CRM_BASE_URL - url of your api to connect to
    • WS_URL - ws://localhost:8090 - url of the webSocket server

    Backend

    • APP_URL_FRONT_END - url of your frontend
    • APP_URL_SSO_AUTH_SERVER - url of your SSO server

Support

If you have something to tell (ask for help, gain extra explanations, propose changes, leave a feedback еtс.), please contact us by e-mail masscrm.support@andersenlab.com.

Roadmap

Our project is on the way to perfection. Thats's why time to time we have updates and releases, as well as improvements and bug fixes. We will keep you in touch by release notes and announcements.

Contributing

Andersen CRM Marketing is open for your proposals. The project source code repositories are hosted at GitHub. All proposed changes are submitted and code reviewed using the GitHub Pull Request process.

To submit a pull request:

  1. Commit changes and push them to your fork on GitHub. It is a good practice to create branches instead of pushing to master.
  2. In GitHub Web UI click the New Pull Request button.
  3. Select _____ as base fork and master as base, then click Create Pull Request.
  4. Fill in the Pull Request description.
  5. Click Create Pull Request.
  6. Select reviewers: Front Back
  7. Wait for CI results/reviews, process the feedback.

All contributions are considered as original BSD unless it's explicitly stated otherwise.

We require pull request submitters to sign the contributor agreement. Please downloand the Agreement, complete it and sign, then scan and email a pdf file to masscrm.legal@andersenlab.com.

Once your Pull Request has passed the rewiew and it's ready to be merged, it will be included in upcoming release.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

Andersen CRM Marketing BSD licensed

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.