Skip to content

radcliffetech/crm-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status License Tech Stack


CRM Project - Massachusetts Institute for Integrated Metaphysics

An example of a lightweight CRM (Customer Relationship Management) platform built with:

  • Django + Django REST Framework for the backend API
  • Remix + TypeScript + Tailwind CSS for the frontend
  • Designed for managing students, courses, instructors, and registrations
  • Demo-friendly layout with modular, modern code structure

About the MiiM

MiiM is a fictional institute created for the purpose of this project, a mix of MIT, Miskatonic U, and Hogwarts. It serves as an abstact placeholder for a real-world organization.

MiiM is a university located mostly in the New England of the US, and usually now. Go Flaming Eyes!

About this Repo

This is a sample Customer Relationship Management (CRM) application developed as part of a software engineering portfolio. It demonstrates full-stack development skills using TypeScript, React, and Remix.


📸 Screenshots

Dashboard View

Dashboard Screenshot

Student Registration

Student Registration Screenshot


🛠️ Tech Stack

  • Backend: Django 5, Django REST Framework
  • Frontend: Remix, TypeScript, Tailwind CSS
  • Database: SQLite (for local development)
  • Hosting: Localhost (dev only)

✨ Features

  • User management (Students, Faculty, Admins)
  • Course creation and registration
  • RESTful API backend
  • Full-featured React frontend
  • Modular, scalable project structure

🚀 Setup Instructions

1. Clone the repository

git clone https://github.com/radcliffetech/crm-app.git
cd crm-app

2. Backend Setup (Django)

cd packages/backend-django
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver 8080

3. Frontend Setup (Remix)

Open a second terminal:

cd packages/frontend-remix
npm install
npm run dev

You should now have:

  • Backend running at http://localhost:8080/
  • Frontend running at http://localhost:5173/

📦 Project Structure

crm-app/
├── packages/
│   ├── backend-django/   # Django REST Framework API
│   └── frontend-remix/   # Remix frontend with React, Tailwind, and TS
└── README.md

🧱 Backend Setup (Django)

  1. Navigate to the backend directory:

    cd packages/backend-django
  2. Create and activate a virtual environment:

    python3 -m venv env
    source env/bin/activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run migrations and load sample data:

    python manage.py migrate
    python manage.py reset_database
  5. Start the server:

    python manage.py runserver 8080

🎨 Frontend Setup (Remix)

  1. Navigate to the frontend directory:

    cd packages/frontend-remix
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

🛣️ Roadmap

Planned future enhancements for the CRM:

  • Mock Payments
  • Registrations & Payments - Tracking and Manaegment
  • Course Calendar
  • Course Catalog (with AI)
  • Support multiple user roles: Admin, Faculty, and Students
  • Add a messaging system for CRM users

About

Sample CRM for a whimsical school

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors