[![Github Stars][gh_stars]][repo]

AssoSuite is a complete free, open source solution to manage assosiations.

• Manage personal / adherents
• Reports / Statistics
• Manage fundraising
• Automtised mailling service
• Manage events

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

What things you need to install the software and how to install them

• clone the project

• node v12.18.3
• yarn v1.2.5
• Openjdk 11
• maven v3.6
• mongo 4.2

Assosuite contains 2 components backend and frontend

To get a development env running you should follow each component documentation.

• backend
• frontend

If you want to use Docker to get a developpement environment:

• in assosuite root directory run

docker-compose up -d

You'll have 4 running containers: - backend - frontend - mongo - mail

You can find more information about our mail server configuration here

you should have a basic knowledge about docker and docker compose to better utilisation

• A VM with docker and docker-compose installed
• A Domain Name with 2 address records (A) see in order to have 2 subdomains that will be used by the frontend and backend.

Example:
backend.organisation.com
frontend.organisation.com

• copy .env-prod-sample, docker-compose-prod.yml config-sample to you deployment environment or use this command:

curl -o .env https://raw.githubusercontent.com/tolstoyfafa/assos_suite/master/.env-prod-sample

curl -o docker-compose.yml https://raw.githubusercontent.com/tolstoyfafa/assos_suite/master/docker-compose-prod.yml

• rename .env-prof-sample to .env and docker-compose-prod.yml to docker-compose.yml and config-sample to config

the config directory contains nginx server configuration that you can customize as you wish, and dynamic.yaml file used to redirect http traefik to https

you can follow this documentation to use Gmail SMTP https://support.cloudways.com/configure-gmail-smtp/

• set your local settings in the .env (read the comments on the env-prod-sample file)

NB: To enable https we are using Let's encrypt see documentation

• Then at last just execute this command to get a running production environment:

docker-compose up -d 

Please read CONTRIBUTING.md

Git

• BORDJAH Fayçal - fayçal Bordjah
• EL HITARY Meraouane - Merouane El hitary

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details

A special thanks to Hiren PATEL and Jackques ATACAN for they helps on the project