• Backend: OCaml 🐪

  • Sihl: OCaml framework for building web apps
  • Opium: OCaml library for managing HTTP requests
  • Caqti: OCaml library for interacting with databases
  • Yojson: OCaml library for JSON serialization
  • Validate: OCaml library for validating schemas

• Frontend: JavaScript 🤢

  • Sveltekit: JavaScript framework for web development
  • Tailwind CSS: CSS framework
  • DaisyUI: Tailwind components library

• Database: 🐘

  • PostgreSQL: relational database

• Backend: Docker 🐳 + GitHub Actions 🤖

  • each time a commit is pushed to the main branch, deploy-backend GitHub action is triggered
  • the action connects via ssh to the server, pulls the changes and rebuilds the Docker container
  • the backend is available at https://cessadvisorapi.favo02.dev
  • instructions:
    • add HOST, USERNAME, PORT, KEY, SCRIPT secrets to GitHub
    • add private KEY provided in secrets to allowed hosts on server
    • clone this repository on the server
    • create .env file in the root of the repository (see .env.template for reference)
    • create empty folder logs in the root of the repository
    • SCRIPT secret should cd into the repository and run git pull and docker-compose up -d --build --force-recreate

• Frontend: Cloudflare Pages ☁️

  • each time a commit is pushed to the main branch, the Cloudflare pages integration detects the change
  • the integration builds the Sveltekit app with some magic
  • the frontend is available at https://cessadvisor.pages.dev
  • instructions:
    • create a new Cloudflare Pages project
    • follow instructions to connect the project to the GitHub repository
    • set Root directory (advanced) as frontend
    • set environment variables (see frontend/.env.template)

This project follows the following commit convention: <type>(<part>/<scope>): <summary>

• Type: commit type

  • feat: add new feature
  • fix: bug fix
  • refactor: code refactoring
  • build: build system (dependencies, ...)
  • test: add tests
  • docs: documentation changes
  • ci: continuous integration (github actions, ...)

• Module/Scope: commit part (mandatory) and scope (optional)

  • be/: backend
    • handlers: request handlers
    • middlewares: middleware functions
    • utils: utility module
  • fe/: frontend
    • components: components
    • pages: pages (client side)
    • ssr: server side rendered pages
    • services: interaction with backend API
    • validators: form validators
  • db/: database
    • tables: tables
  • repo: repository (omit scope)

• Summary: commit summary, present tense, start with lowercase, no period at the end

Adding new scopes is allowed if necessary, just add it to the list above.