https://github.com/safe-global/safe-docs
Developer Docs for building on Safe.
https://github.com/safe-global/safe-docs
developer-tools documentation ethereum safe smart-contracts
Last synced: 4 months ago
JSON representation
Developer Docs for building on Safe.
- Host: GitHub
- URL: https://github.com/safe-global/safe-docs
- Owner: safe-global
- License: mit
- Created: 2018-07-29T19:35:58.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2026-02-23T09:01:51.000Z (4 months ago)
- Last Synced: 2026-02-23T16:10:15.256Z (4 months ago)
- Topics: developer-tools, documentation, ethereum, safe, smart-contracts
- Language: MDX
- Homepage: https://docs.safe.global
- Size: 34.4 MB
- Stars: 62
- Watchers: 11
- Forks: 88
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Safe Documentation
[](https://github.com/safe-global/safe-docs/blob/main/LICENSE.md)
This repository hosts [Safe](https://safe.global) documentation.
The documentation is built with [Nextra](https://nextra.site) and is live at [docs.safe.global](https://docs.safe.global).
## Installation
Install the dependencies using [pnpm](https://pnpm.io):
```
pnpm install
```
## Development
Git hooks are set up to run tests and linting checks before every `git push`. These hooks can be executed locally by running the following command:
```
pnpm prepush
```
All links in the documentation are checked for validity on every pull request. These checks can be executed locally by running the following command:
```
pnpm linkcheck
```
## Execution
The project can be run with a server that's executed in development and production mode.
### Development mode
Run the server in development mode using the following command:
```
pnpm dev
```
### Production mode
Build the project:
```
pnpm build
```
Run the server in production mode using the following command:
```
pnpm start
```
## Testing
Create an environment file in the root of the project and copy the content from the `.env.example` file using the following command:
```
cp .env.example .env
```
Remember to update the environment variables once the `.env` file is created.
Run the tests using the following command:
```
pnpm test
```
## License
This project is licensed under the [MIT License](./LICENSE.md).
## Contributing
Contributions are more than welcome! Please open an issue or create a pull request by following our [contributions guidelines](./CONTRIBUTING.md).