This guide is for software developers who want to contribute to CareLoom or run it locally for development.
- Local Setup -- get the three services running on your machine
- Architecture -- understand how the services communicate
- Pick the service you want to work on:
- Backend (API) -- Spring Boot, Java 8, Flyway
- Admin Dashboard -- Vite, React 18, TypeScript, Ant Design
- Mobile App -- Expo, React Native, Redux
- Database -- MySQL schema, Flyway migrations
- Testing -- how to run tests for each service
| Guide | What It Covers |
|---|---|
| Local Setup | Prerequisites, cloning, running each service locally |
| Architecture | How the three services communicate, package structure |
| Backend | Spring Boot conventions, adding endpoints, Flyway migrations |
| Admin Dashboard | Vite/React project structure, Ant Design, Zustand state |
| Mobile App | Expo/React Native structure, Redux, building APKs |
| Database | MySQL schema, migration conventions, key tables |
| Testing | Running tests per service, testing conventions |
- Architecture Overview -- high-level system design and data model
- Environment Variables Reference -- all config variables across services
- API Reference -- key REST endpoints