An open API service indexing awesome lists of open source software.

https://github.com/pimp-my-book/goa-student-documentation

Documentation for Pimp My Book's GOA app, powered by Gridsome
https://github.com/pimp-my-book/goa-student-documentation

Last synced: about 2 months ago
JSON representation

Documentation for Pimp My Book's GOA app, powered by Gridsome

Awesome Lists containing this project

README

        

# GOA Documentation

This repo houses the documentation for Pimp My Book's GOA app that allows bursary students to order their books for university.

## Prerequistes

* NodeJS >= 8.0.0
* Yarn

## Installion & Development Instructions

First go head and clone the repo:

```
$ git clone https://github.com/pimp-my-book/goa-student-documentation.git
```
Make sure you change directories:

```
$ cd goa-student-documentation
```

Install Gridsome CLI tool if you don't have

```
yarn install --global @gridsome/cli
```

Then make sure you install the dependancies:

```
$ yarn install
```

To start the dev server:

```
$ yarn develop
```

To build for production:

```
$ yarn build
```

## License

MIT