okgrow/coursebook-server

OK GROW! kwiz

OK GROW! kwiz is a fork of Arunoda's amazing "coursebook" repositories. It consists of this repo: okgrow/coursebook-server and okgrow/coursebook-ui

This is the code powering the server for OK GROW! kwiz. The app was built in an effort to keep users up to date with details around various frameworks like React and GraphQL. The code for this app was made public to encourage users to discuss answers and add questions.

Table of Contents

• Install
• Configuration
• Development
• Deployment
  • Page views
• Maintenance
• Contributing
• License

Install

git clone git@github.com:okgrow/coursebook-server.git
cd coursebook-server
yarn

Configuration

Your now.json according to the details in google drive. Example

{
  "name": "okgrow-coursebook-server",
  "env": {
    "NODE_ENV": "production",
    "BACKEND_URL": "https://okgrow-coursebook-server.now.sh"
    "ADMIN_TOKEN": ""
    "MONGO_URL": ""
    "SESSION_SECRET": ""
    "GITHUB_CLIENT_ID": ""
    "GITHUB_CLIENT_SECRET": ""
  },
  "alias": "okgrow-coursebook-server.now.sh"
}

Development

To run locally:

npm run dev

Deployment

To deploy new material run, depending on the chapter you want to publish:

npm run react

which runs

coursebook-publish https://okgrow-coursebook-server.now.sh admin scripts/react

To actually deploy to the server, run:

npm run deploy

Maintenance

This package is a fork of arunoda's coursebook-server and we will try to keep up to date with that repo. The main difference between this repository and the original is the content of the quizes and this Readme!

@okgrow

Feel free to ping if there are open issues or pull requests which are taking a while to be dealt with!

Contributing

To add questions make a pull request and add your question following the pattern in the scripts folder.