Textwire Documentation

Docs build with Docusaurus.

Contribute

NPM Commands

Install Dependencies

npm install

Watch File Changes

npm start

Navigate to http://localhost:3000 to see your documentation.

With Container Engine

Build an Image

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

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

For Podman:

podman-compose up -d

For Docker:

docker compose up -d

You can visit http://localhost:3000 to see your documentation. Your files will be auto-compiled to plain JavaScript as you change them.

Enter the Container

To enter inside of the container, run 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.

Tip

You don't need to run npm start because it's already running after you created a container.

Delete the Container

After you are done working on a project, you can cleanup by stopping and removing all the running containers for this project.

For Podman:

podman-compose down

For Docker:

docker compose down