Smooth Loader Web Documentation

Official documentation website for smooth-loader package for JavaScript

If you found any typo or want to improve the website, go ahead for a pull request. I would gladly review and merge your changes.

Development

Build an Image

To build an image, navigate to the root of the project and run this:

For Podman:

podman-compose build

For Docker:

docker compose build

Create node_modules

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

For Podman:

podman-compose run --rm app npm i

For 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.

For Podman:

podman-compose up -d

For Docker:

docker compose up -d

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

Enter the Container

To enter inside of the container, use this command.

For Podman:

podman-compose exec app sh

For Docker:

docker compose exec app sh

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

Stop the Container

To cleanup after your work, use this command.

For Podman:

podman-compose down

For Docker:

docker compose down

NPM Commands

Install Dependencies

npm i

Watch File Changes

npm run dev

Navigate to http://localhost:5173 to see your documentation if you run the project locally. If you use container engine, navigate to http://localhost:3000 instead.