Merge pull request #214 from thoughtsunificator/patch-1

Add steps to install and run soul via Docker
This commit is contained in:
Vahid Al
2024-12-02 22:56:07 +03:30
committed by GitHub

View File

@@ -8,16 +8,43 @@
[![justforfunnoreally.dev badge](https://img.shields.io/badge/justforfunnoreally-dev-9ff)](https://justforfunnoreally.dev) [![justforfunnoreally.dev badge](https://img.shields.io/badge/justforfunnoreally-dev-9ff)](https://justforfunnoreally.dev)
[![All Contributors](https://img.shields.io/github/all-contributors/thevahidal/soul?color=ee8449&style=flat-square)](#contributors) [![All Contributors](https://img.shields.io/github/all-contributors/thevahidal/soul?color=ee8449&style=flat-square)](#contributors)
## Installation ## Usage
Install Soul CLI with npm ### Docker
> This is the preferred method as the dependency [better-sqlite3](https://github.com/WiseLibs/better-sqlite3) is making of lot of assumptions about the system it will be installed and running on which in most cases will lead to errors when installing soul.
Using the following Dockerfile:
<details>
<summary>Dockerfile</summary>
```nginx
# node:19-alpine amd64
FROM node@sha256:d0ba7111bc031323ce2706f8e424afc868db289ba40ff55b05561cf59c123be1 AS node
WORKDIR /app
ENV NODE_ENV="production"
COPY package-lock.json package.json ./
RUN apk update && apk add python3=3.11.10-r1 build-base=0.5-r3 && npm ci
COPY . .
CMD [ "npm", "start" ]
```
</details>
You can proceed [to building the application](https://docs.docker.com/get-started/workshop/02_our_app/#build-the-apps-image).
### npm
```bash ```bash
npm install -g soul-cli npm install -g soul-cli
``` ```
## Usage
### 1. Running Soul ### 1. Running Soul
Soul is command line tool, after installing it, Soul is command line tool, after installing it,