Skip to content

Commit

Permalink
updated readme (#171)
Browse files Browse the repository at this point in the history
* updated readme

* changelog
  • Loading branch information
genevievehelsel committed Dec 1, 2018
1 parent 5dbeeb3 commit 9b2f69f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Expand Up @@ -12,6 +12,7 @@ with the current date and the next changes should go under a **[Next]** header.
* Updated API documentation. ([@genevievehelsel](https://github.com/genevievehelsel) in [#170](https://github.com/illinois/queue/pull/170))
* Fix readme typo and prettierignore. ([@genevievehelsel](https://github.com/genevievehelsel) in [#159](https://github.com/illinois/queue/pull/159))
* Sort courses in "Create a queue" panel. ([@ApoorvaDixit](https://github.com/ApoorvaDixit) in [#167](https://github.com/illinois/queue/pull/167))
* Update README. ([@genevievehelsel](https://github.com/genevievehelsel) in [#171](https://github.com/illinois/queue/pull/171))

## 22 October 2018

Expand Down
36 changes: 24 additions & 12 deletions README.md
Expand Up @@ -2,27 +2,39 @@

[![Build Status](https://travis-ci.org/illinois/queue.svg?branch=master)](https://travis-ci.org/illinois/queue)

A micro-service queue for holding office hours.
A micro-service queue for holding open office hours.

Join the #queue-dev channel on the [UIUC OSS Slack team](https://illinois-oss.slack.com) to keep up with development!
Join the #queue-general channel on the [UIUC OSS Slack team](https://illinois-oss.slack.com) to keep up with the queue!

## Using the Queue at Illinois

At UIUC, this queue is hosted as a free service by Computer Science and EngrIT.

* View the queue at https://edu.cs.illinois.edu/queue/
* [Request to have a queue created for your course by filling out this short form](https://forms.illinois.edu/sec/691281)
- View the queue at https://queue.illinois.edu/
- [Request to have a queue created for your course by filling out this short form](https://forms.illinois.edu/sec/691281)

## Contribution Guidelines

- Join the #queue-dev channel on the [UIUC OSS Slack team](https://illinois-oss.slack.com) to seek development support
- Claim an issue by commenting on an open issue in order to indicate to others that you are working on the task
- Once you are ready to submit for review make sure to:
- Include a `CHANGELOG.md` entry following existing format
- If making API changes, note the change in `API.md`
- If your change requires new dependencies, add them to `package.json`
- Tag a lead developer in the reviewers section

If you wish to report a bug, feature request, etc., please open a new issue (first checking that your issue has not already been filed).

## Running the Queue from Source

### Running locally in `dev` mode:

* Clone the repository
* Install [`node` and `npm`](https://nodejs.org/en/download/package-manager/)
* Install dependencies: `npm install` in the cloned directory
* Start the server: `npm run dev`
* Access the queue from a browser at `localhost:3000`
* You can run it on a different port by setting the `PORT` environment variable
- Clone the repository
- Install [`node` and `npm`](https://nodejs.org/en/download/package-manager/)
- Install dependencies: `npm install` in the cloned directory
- Start the server: `npm run dev`
- Access the queue from a browser at `localhost:3000`
- You can run it on a different port by setting the `PORT` environment variable

### Multiple users in dev mode

Expand All @@ -42,8 +54,8 @@ multiple incognito windows.

Several configuration options are exposed via environment variables:

* `PORT`: controls which port the app will be served from.
* `BASE_URL`: allows the app to be served from somewhere other than the server
- `PORT`: controls which port the app will be served from.
- `BASE_URL`: allows the app to be served from somewhere other than the server
root. This affects asset and API routes, websocket endpoints, generated links,
and more. Note that for this to work effectively, the app must still receive
the base URL as part of the request; this is important if the app is
Expand Down

0 comments on commit 9b2f69f

Please sign in to comment.