mona-ca

OpenAPI

What is mona-ca?

mona-ca is an Application that shares information about a girl's period with her partner.

With customizable UI and messages, users can manage their menstrual cycles and share them with their partners.

Project Structure

The project uses a mono-repo structure, with the main functions and modules organized in the following directories

📱 apps

The directory that manages the source code of the application.

• 🌐 web - Web application
  • Next.js and React are used for the frontend implementation.
• 📱 mobile - Mobile application
  • React Native is used for the cross-platform app.
• 🖥️ api - API server
  • Elysia and Bun are used for the backend implementation.

📦 packages

The directory that manages reusable packages for the project.

• ⚙️ core - Core package
  • Common functions related to business logic and data processing.
• 🎨 ui - UI package
  • Common functions related to React components and styling.

🛠️ tools

The directory that manages tools and settings related to development and operation.

Setup the Development Environment

1. clone git repository

git clone https://github.com/koutyuke/mona-ca.git && cd mona-ca

2. install runtime & package manager

We use mise as a version control tool.

mise install

3. set environment variables

See .env.example for each application

4. install dependencies

bun i

5. set git hook

bunx lefthook install

Docker Compose

# up
docker compose up -d

# down
docker compose down

Development Tool Commands

Perform various checks on all files.

# build
bun run build

# static code check(lint, fmt, imports)
bun run check

# static code check(lint, fmt, imports) & fix
bun run check:fix

# type check
bun run typecheck

# test
bun run test

# Other
# See `scripts` field in `package.json`