Skip to content

Commit fa73dd5

Browse files
committed
update readme and quickstart, fix config file
1 parent 0157da5 commit fa73dd5

File tree

3 files changed

+27
-13
lines changed

3 files changed

+27
-13
lines changed

README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,40 @@
1-
Q
2-
====
1+
HELPq
2+
=====
33

4-
An extensible, customizable real-time queue system, built with Meteor.
4+
An extensible, customizable real-time queue system, built with [Meteor](https://www.meteor.com/).
55

6-
** This is an alpha release. This queue is fully functional, but code will move around and features will be added over the next few months. Keep checking back for the most up to date. **
6+
** This is beta release. This queue is fully functional, but code will move around and features will be added over the next few months. Keep checking back for the most up to date. **
77

8-
Documentation will be extended in the next few weeks. To start:
8+
Requirements
9+
------------
910

1011
Quickstart
1112
----------
13+
```sh
14+
./create_config
15+
meteor
16+
```
17+
18+
Configuration
19+
-------------
1220
For front end branding, edit `client/stylesheets/scss/_branding.scss`
1321

14-
Compile css with
15-
```sh
22+
Compile css with
23+
```sh
1624
sass --watch client/stylesheets/scss:client/stylesheets/css
1725
```
1826

1927
To edit text, edit `lib/constants.js`
2028

21-
To configure login:
22-
```sh
23-
cp private/config.json.template private/config.json
24-
```
29+
To configure login, edit `private/config.json`
2530

2631
In `private/config.json`, provide the appropriate application id/secret combinations
2732
for either facebook or github authentication, or choose to disable them.
2833

29-
This will also contain the admin account username and password you'll use to login later.
34+
This will also contain the admin account username and password you'll use for the initial login.
3035

31-
Startup with `meteor`
36+
Deploy
37+
------
3238

3339
Deploy with `meteor deploy <your domain name>.meteor.com`
3440

create_config

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash
2+
cp private/config.json.template private/config.json
3+
echo "Server side config created."
4+
echo "Edit it in private/config.json to add Facebook or GitHub integration."

private/config.json.template

+4
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,9 @@
1717
"enable": false,
1818
"clientId": "google-client-id",
1919
"secret": "google-secret"
20+
},
21+
"settings": {
22+
"queueEnabled": true,
23+
"expirationDelay": 1800000
2024
}
2125
}

0 commit comments

Comments
 (0)