Git Product home page Git Product logo

mz_docs's Introduction

Monzo API Docs

Monzo is a new kind of bank.

This is the public repo for the Monzo API documentation. It was generated using 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

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 to this GitHub repo if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes.

mz_docs's People

Contributors

lord avatar obeattie avatar masterodin avatar henryrowett avatar mattheath avatar dependabot-preview[bot] avatar m2a9x45 avatar chrissrogers avatar realityking avatar dependabot[bot] avatar jonastemplestein avatar mycleung avatar kieranm avatar cvkef avatar albertmonzo avatar alexturkin avatar domwong avatar marcguyer avatar bootstraponline avatar samuknet avatar mikeralphson avatar danielchatfield avatar hnphan avatar maks3w avatar greysteil avatar trstnthms avatar dlackty avatar priyeshpatel avatar jnic avatar djpowers avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.