Skip to content
Browse files

Mention where platform features are documented [skip ci] some other cleanup
  • Loading branch information
harigopal committed Mar 1, 2020
1 parent 12a72a6 commit 7ab2740b369c7214f1cbe6510aa1a6e3d8e375da
Showing with 13 additions and 6 deletions.
  1. +13 −6
@@ -1,4 +1,4 @@
![PupilFirst Logo](
![Pupilfirst Logo](
[![License: MIT](](
@@ -12,6 +12,12 @@

Visit []( to view the full changelog.

## Features

Visit []( for a detailed explanation of Pupilfirst's features.

The rest of this README file discusses how to set up this repository for development.

## Setup for development

1. [Install and configure dependencies](#install-and-configure-dependencies)
@@ -216,14 +222,14 @@ This will generate coverage report as HTML within the `/coverage` directory.
If you make any changes to the GraphQL schema, you'll need to update the `graphql_schema.json` file by running an
introspection query.

With the PupilFirst server running, run the `graphql-codegen` script.
With the Pupilfirst server running, run the `graphql-codegen` script.

$ yarn run graphql-codegen

It'll visit the local GraphQL end-point which is configured in the `codegen.yml` file, fetch the schema and store it in
the `graphql_schema.json` file.

## Services
## Running Background Jobs

Background jobs are written using [Rails ActiveJob](, and deferred
using [delayed_job]( in the production environment.
@@ -233,7 +239,10 @@ application to defer them instead, you can execute the jobs with:

$ rake jobs:workoff

## Documentation
## Editing Documentation

The source of []( is stored in the `/docs` folder in this repo, and is
managed using [docsify](

First, install the docsify CLI globally:

@@ -244,5 +253,3 @@ Then serve the `docs` folder on the desired port.
$ docsify serve docs -p 3010

The `-p` option sets the port. Visit `localhost:PORT` to view docs locally.

0 comments on commit 7ab2740

Please sign in to comment.
You can’t perform that action at this time.