Skip to main content

Welcome to SociApp

Comprehensive management platform for neighborhood associations and nonprofits to digitalize member, activity, project, and financial administration.

Get StartedAPI Reference

Quick Start

Get SociApp running in minutes with Docker

1

Clone the repository

Clone the SociApp repository to your local machine:
git clone https://github.com/Reizo0337/SociApp.git
cd SociApp
2

Configure environment variables

Set up your environment variables for the backend:
cd backend
cp .env.example .env
# Edit .env with your database credentials and SMTP settings
Make sure to configure your MySQL database connection and SMTP password for email functionality.
3

Launch with Docker

Start the application using the provided Docker script:
./docker.sh
The application will be available at:
  • Frontend: http://localhost (port 80)
  • Backend API: http://localhost:3000
4

Access the platform

Open your browser and navigate to http://localhost. Register a new account and start managing your association!
The first registered user with the ‘admin’ category will have full administrative access.

Core Features

Everything you need to manage your association

Member Management

Maintain detailed member records with contact information, membership status, and payment tracking.

Activity Scheduling

Plan and monitor activities with instructor assignments and schedule management.

Project Tracking

Track projects with budget control, document uploads, and funding source management.

Financial Configuration

Manage association data, board members, bank accounts, and donation records.

Messaging System

Send individual or mass emails to members directly from the platform.

Dashboard Analytics

View real-time statistics and insights about your association’s activities.

Explore the Documentation

Learn how to use and customize SociApp

Authentication Guide

Learn about JWT authentication, user registration, and role-based access control.

Read guide

Architecture Overview

Understand the technical architecture, from Vue.js frontend to NestJS backend.

Explore architecture

API Reference

Complete REST API documentation with request/response examples and authentication.

View API docs

Docker Deployment

Deploy SociApp in production using Docker Compose with best practices.

Learn deployment

Ready to get started?

Follow our quickstart guide to have SociApp up and running in under 5 minutes.

Start Building

Build docs developers (and LLMs) love

Get started for freeTalk to us