https://github.com/monzo/docs
Public API documentation
https://github.com/monzo/docs
Last synced: about 1 year ago
JSON representation
Public API documentation
- Host: GitHub
- URL: https://github.com/monzo/docs
- Owner: monzo
- Created: 2015-08-11T15:15:51.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T12:17:10.000Z (over 1 year ago)
- Last Synced: 2025-03-24T13:26:59.102Z (over 1 year ago)
- Language: SCSS
- Homepage: https://monzo.com/docs/
- Size: 2.81 MB
- Stars: 103
- Watchers: 164
- Forks: 48
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Monzo API Docs
========
[Monzo is a new kind of bank](https://monzo.com).
This is the public repo for the [Monzo API documentation](https://monzo.com/docs). It was generated using [Slate](https://github.com/slatedocs/slate).
Setting up your environment
-----------------------
Docker is the recommended way to work with this repository, as we can use slate's official Docker image and not worry
about dependencies, however if you want to work with the project natively `rbenv` is recommended.
Testing Locally
-----------------------
From the root of the repo:
```
> docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve
```
Then just visit http://localhost:4567 in your browser!
Upgrading Slate
-----------------------
Follow the instructions on [Slate's GitHub page](https://github.com/slatedocs/slate/wiki/Updating-Slate)
Deploying your changes
-----------------------
Make sure all your changes are committed and then build the project
```
docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build
```
This will create the `build/` folder (don't worry about committing this, it's part of the `.gitignore` file). You can now
deploy:
```
./deploy.sh --push-only
```
Note the --push-only flag is required as otherwise the script will try to build the project first natively, which we've
already done with Docker.
Need help? Found a bug?
-----------------------
Just [submit an issue](https://github.com/monzo/docs/issues) to this GitHub repo if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes.