An open API service indexing awesome lists of open source software.

https://github.com/miolab/kokuraex

This repository is for the development of kokura.ex organization's website.
https://github.com/miolab/kokuraex

cicd docker elixir phoenix-framework

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README

          

# kokura.ex

[![miolab](https://circleci.com/gh/miolab/kokuraex.svg?style=svg)](https://github.com/miolab/kokuraex)

# About

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

```mermaid
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,
allow merge to main branch|GH;
CI-->|When main branch merged, run Render deploy hook|R;
R-.->|Using main branch's latest files for deploy|GH;
```

## Versions

- Elixir 1.19.5 (Erlang/OTP 28)
- Phoenix 1.8.3

## CI/CD tool

- CircleCI

## PaaS

- Render

---

## For Dev

- Prepare `SECRET_KEY_BASE` and `GITHUB_API_TOKEN` ([ref](https://github.com/settings/tokens)).
- Set them to .env file.

```sh
docker compose run app mix phx.gen.secret
```

```sh
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)

```sh
docker compose build
```

```sh
docker compose up
```

- Development verifying in a production environment

```sh
./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

![system_diagram 001](https://user-images.githubusercontent.com/33124627/136857102-179c26ed-7e01-449a-98c9-07e433f7ab87.jpeg)