Gnome app

Commit Messages

This project uses Conventional Commits for commit messages. Husky will validate all commit messages to ensure they follow this format.

Valid commit message examples:

• feat: add new feature
• fix: resolve bug in component
• docs: update README
• refactor: improve code structure
• test: add unit tests
• chore: update dependencies

The format is: <type>(<optional scope>): <description>

Development

Install dependencies:

  yarn install

Backend service

Create a .env file based on .env.example in apps/gnome-back directory and fill in the necessary values.

Setup docker on your machine and run the following command to start services:

  docker-compose up -d

Migrate db:

  cd apps/gnome-back
  npx prisma generate
  npx prisma migrate dev

Run the following command to start the backend service:

  yarn dev

Setup Minio credentials:

• enter http://localhost:9001 using the username and password you set in .env file
• create a bucket named images at http://localhost:9001/buckets/add-bucket
• create Access Key and Secret Key at http://localhost:9001/access-keys/new-account
• • update variables MINIO_ACCESS_KEY and MINIO_SECRET_KEY in the .env file with the new Access Key and Secret Key

Mobile app

Create a .env file based on .env.example in apps/gnome-mobile directory and fill in the necessary values.

You can start the mobile app by running the following commands:

  yarn workspace gnome-mobile prebuild
  yarn workspace gnome-mobile android