README.md

kokura.ex

About

This repository is for the development of kokura.ex's org website.

graph TD;
subgraph Docker
    Elixir
    Phoenix
end
subgraph R[Build and Deploy using Docker image]
    Render
end
    Docker-->|git push to GitHub|GH[GitHub];
    GH-->|Detection of changes|CI[CircleCI];
    CI-->|After CI passed,<br>allow merge to <strong>main</strong> branch|GH;
    CI-->|When <strong>main</strong> branch merged, run Render deploy hook|R;
    R-.->|Using <strong>main</strong> branch's latest files for deploy|GH;

Loading

Versions

• Elixir 1.16.2 (Erlang/OTP 26)
• Phoenix 1.7.12

CI/CD tool

• CircleCI

PaaS

• Render

---

For Dev

• Prepare SECRET_KEY_BASE and GITHUB_API_TOKEN (ref).

• Set them to .env file.

  docker compose run app mix phx.gen.secret

  cp app/.env.sample app/.env

• Set the environment variable to Render.

  • SECRET_KEY_BASE
  • PORT
  • PHX_SERVER
  • GITHUB_API_TOKEN

Run application in local development

• Normal development (can debug by live reloading)

  docker compose build

  docker compose up

• Development verifying in a production environment

  ./script/docker_prod_verify.sh

---

Other Information

The previous system architecture and archived repositories are as follows.

https://github.com/miolab/kokuraex_phx_1_6/tree/main