https://github.com/php-ago/php-ago.github.io

Frontend documentation for the PHP package "ago"
https://github.com/php-ago/php-ago.github.io

docker docs documentation vitepress

Last synced: 3 months ago
JSON representation

Frontend documentation for the PHP package "ago"

README

# Documentation website for [ago](https://github.com/php-ago/ago) library

## Contribute

### NPM Commands
#### Install Dependencies
```bash
npm i
```

#### Watch File Changes
```bash
npm run dev
```

Navigate to `http://localhost:5173` to see your documentation if you run project locally. For containers, visit `http://localhost:3000`.

### With Container Engine
#### Build an Image
To build an image, navigate to the root of the project and run this command.

With Podman:
```bash
podman-compose build
```

With Docker:
```bash
docker compose build
```

#### Create `node_modules`
Run this command to install npm packages and generate a `node_modules` directory on your local machine.

With Podman:
```bash
podman-compose run --rm app npm i
```

With Docker:
```bash
docker compose run --rm app npm i
```

#### Run the Container
To run a container, navigate to the root of the project and run this command.

With Podman:
```bash
podman-compose up -d
```

With Docker:
```bash
docker compose up -d
```

You can visit `http://localhost:3000` to see your documentation.

#### Enter the container
To enter inside of the container, run this command.

With Podman:
```bash
podman-compose exec app sh
```

With Docker:
```bash
docker compose exec app sh
```

You'll be able to run NPM commands inside of the container.

#### Stop the container
After you are done working, run this to cleanup containers.

With Podman:
```bash
podman-compose down
```

With Docker:
```bash
docker compose down
```