SettleMint - Documentation

✨ https://settlemint.com ✨
Get going with SettleMint in minutes.

Documentation   •   Issues

Prerequisites

Make sure you have Bun installed on your system. If not, you can install it by running:

curl -fsSL https://bun.sh/install | bash

Installation

1. Clone the repository:

git clone https://github.com/settlemint/docs
cd yourproject

2. Install dependencies:

bun install

Available Scripts

In the project directory, you can run:

Development

bun run dev

This starts the development server with hot-reload enabled. Navigate to /documentation

Build

bun run build

This command builds the application for production use.

Production

bun run start

Runs the built application in production mode.

Troubleshooting

If you encounter any issues:

1. Make sure Bun is up to date:

bun upgrade

2. Clear Bun's cache:

rm -rf node_modules
rm bun.lockb
bun install

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request