Skip to content

Commit

Permalink
Updated the CSS version. Reverted the browserSync settings. Updated R…
Browse files Browse the repository at this point in the history
…EADME.
  • Loading branch information
stefanbohacek committed Mar 15, 2017
1 parent e0d09c9 commit 202a83c
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 7 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Also, here's a [list of bots](https://github.com/botwiki/botmakers.org/blob/mast

This repo also serves as a template for a neat-looking auto-invite page for your Slack community. It is loosely based on [outsideris/slack-invite-automation](https://github.com/outsideris/slack-invite-automation), but kept simpler and easier to customize. You can easily host it on [OpenShift](https://www.openshift.com/) or [Heroku](https://www.heroku.com/).

(Note: the code could use a bit more cleanup, but I was in a rush to open the Botmakers community.)
Note: the code could use a bit more cleanup, but I was in a rush to open the Botmakers community :-)

Running this thing is pretty simple:

Expand All @@ -24,19 +24,22 @@ Running this thing is pretty simple:
3. `slacktoken`: get yours [here](https://api.slack.com/web#auth)
3. Make a copy of `visitor_stats-example.handlebars` (it's inside the `views/partials` folder) and call it `visitor_stats.handlebars`. Here you can paste your Google Analytics or StatCounter (or similar) code.
4. Install dependencies with `npm install` (or `sudo npm install`, if necessary).
5. `gulp.js`
5. I recommend using [pm2](https://github.com/Unitech/pm2) to run the app on your server.

Enjoy!


A few more notes:

Please remove `{{> userengage }}` from `/views/layouts/main.handlebars`. (This is a script from [userengage.io](https://userengage.io/)). You can also remove the actual file `/views/partials/userengage.handlebars`.

About the **step 3** above: If you don't need to include this code, you can simply leave the file empty, but note that this file is by deafult not going to be committed, so you will have to either update `.gitignore` to remove the file from the list, or, if you want to keep your site's code open, upload this file separately.

You can also edit the file `main/handlebars` inside the `views/layouts` folder and remove the line that says `{{> visitor_stats }}` and get rid of the file completely.

As for hosting your signup page on Heroku, note that Heroku's free plan [forces your app to sleep for a few hours every day](https://www.heroku.com/pricing), so I don't recommend using Heroku if you expect a lot of traffic spread roughly evenly throughout the day, as you might lose signups.

And finally, you might also want to update the [error messages](https://github.com/botwiki/botmakers.org/blob/master/botmakers.js#L49) to include your email/link to your Twitter page/etc.


If you want to develop this app, you can run `gulp.js`. The app will run at `http://localhost:3011/`, and there is a proxy at `http://localhost:4000/` that has code hot swapping (changes to the styles or script files are immediately visible without reloading the page).

Note that you might need to reload the page if it gets stuck loading after you run `gulp` the first time. `/shrug`
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ gulp.task('browser-sync', ['nodemon'], function () {

browserSync.init(files, {
proxy: "localhost:3011",
port: 3011
port: 4000
});
});

Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion public/js/scripts.1.1.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

File renamed without changes.
2 changes: 1 addition & 1 deletion views/layouts/main.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<!--[if lt IE 9]>
<script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" href="css/styles.1.19.min.css">
<link rel="stylesheet" href="css/styles.1.20.min.css">
<meta name="msapplication-TileColor" content="#FFFFFF">
<meta name="msapplication-TileImage" content="images/favicon-144.png">
<link rel="shortcut icon" href="images/favicon.ico"/>
Expand Down

0 comments on commit 202a83c

Please sign in to comment.