Documentation website for ago library

Contribute

NPM Commands

Install Dependencies

npm i

Watch File Changes

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:

podman-compose build

With Docker:

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:

podman-compose run --rm app npm i

With Docker:

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:

podman-compose up -d

With Docker:

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:

podman-compose exec app sh

With Docker:

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:

podman-compose down

With Docker:

docker compose down