Add cooler shell characters to README
This commit is contained in:
20
README.md
20
README.md
@@ -21,36 +21,36 @@ GIA runs inside **Podman containers**. Ensure you have **Podman** and **Podman C
|
|||||||
|
|
||||||
1. **Clone the repository**
|
1. **Clone the repository**
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/your-repo/gia.git
|
❯ git clone https://github.com/your-repo/gia.git
|
||||||
cd gia
|
❯ cd gia
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Set up the environment variables
|
2. Set up the environment variables
|
||||||
```shell
|
```shell
|
||||||
cp stack.env.example stack.env
|
❯ cp stack.env.example stack.env
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Edit `stack.env`
|
3. Edit `stack.env`
|
||||||
|
|
||||||
4. Build and start the containers
|
4. Build and start the containers
|
||||||
```shell
|
```shell
|
||||||
make build
|
❯ make build
|
||||||
make run
|
❯ make run
|
||||||
```
|
```
|
||||||
|
|
||||||
5. Run database migrations
|
5. Run database migrations
|
||||||
```shell
|
```shell
|
||||||
make migrate
|
❯ make migrate
|
||||||
```
|
```
|
||||||
|
|
||||||
6. Create a superuser for Django Admin (optional but recommended)
|
6. Create a superuser for Django Admin (optional but recommended)
|
||||||
```shell
|
```shell
|
||||||
make auth
|
❯ make auth
|
||||||
```
|
```
|
||||||
|
|
||||||
7. Monitor logs
|
7. Monitor logs
|
||||||
```shell
|
```shell
|
||||||
make log
|
❯ make log
|
||||||
```
|
```
|
||||||
|
|
||||||
## ⚙️ Deployment & Architecture
|
## ⚙️ Deployment & Architecture
|
||||||
@@ -70,13 +70,13 @@ GIA runs inside **Podman containers**. Ensure you have **Podman** and **Podman C
|
|||||||
|
|
||||||
You can execute management commands inside the app container using:
|
You can execute management commands inside the app container using:
|
||||||
```shell
|
```shell
|
||||||
docker-compose --env-file=stack.env run --rm app sh -c ". /venv/bin/activate && python manage.py <command>"
|
❯ docker-compose --env-file=stack.env run --rm app sh -c ". /venv/bin/activate && python manage.py <command>"
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🛑 Stopping GIA
|
## 🛑 Stopping GIA
|
||||||
To stop all running services:
|
To stop all running services:
|
||||||
```shell
|
```shell
|
||||||
make stop
|
❯ make stop
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🕵️♂️ Operational Modes
|
## 🕵️♂️ Operational Modes
|
||||||
|
|||||||
Reference in New Issue
Block a user