/startupwichita.com

A community site for bringing connection and awareness to the Tech and Startup Communities in Wichita

Primary LanguageJavaScriptMIT LicenseMIT

startupwichita.com

A community site for bringing connection and awareness to the Tech and Startup Communities in Wichita, KS.

Setup

You can run a copy of the site on a VM on your machine using VirtualBox and Vagrant.

Installing VirtualBox

Download and run an installer from VirtualBox Downloads.

Installing Vagrant

Download and run an installer from Vagrant Downloads.

Create and Provision the VM

For Mac and Linux run the following from the checkout of the project.

vagrant up                     # This can take 15 minutes depending on your
                               # machine and network
vagrant ssh                    # This will open a shell connection to your VM
cd /var/www/startupwichita.com # This will put you in the project directory
npm install                    # This can take another 5 minutes
grunt                          # This will run the default grunt task which
                               # will start the server

Wait until you see the line Express app started on port 3000. Leave that terminal window open for as long as you want the server to be running. You can type rs and Enter to restart the server.

In a web browser open http://localhost:3000.

Contributing

To contribute to the development of startupwichita.com, please read the guide to contributing.

Attributions

This site is built on the MEAN Stack. Details of the stack are outlined below.


MEAN Stack

MEAN is a boilerplate that provides a nice starting point for MongoDB, Node.js, Express, and AngularJS based applications. It is designed to give you quick and organized way to start developing of MEAN based web apps with useful modules like mongoose and passport pre-bundled and configured. We mainly try to take care of the connection points between existing popular frameworks and solve common integration problems.

Prerequisites

  • Node.js
  • MongoDB

Tools Prerequisites

  • NPM - Node.js package manager
  • Bower - Web package manager
  • Grunt - Task Runner

Additional Packages

  • Express
  • Mongoose
  • Passport
  • AngularJS
  • Twitter Bootstrap
  • UI Bootstrap

Configuration

All configuration is specified in the config folder, particularly the config.js file and the env files. Here you will need to specify your application name, database name, as well as hook up any social app keys if you want integration with Twitter, Facebook, GitHub or Google.

Environmental Settings

There are three environments provided by default, development, test, and production. Each of these environments has the following configuration options:

  • db - This is the name of the MongoDB database to use, and is set by default to mean-dev for the development environment.
  • app.name - This is the name of your app or website, and can be different for each environment. You can tell which environment you are running by looking at the TITLE attribute that your app generates.
  • Social OAuth Keys - Facebook, GitHub, Google, Twitter. You can specify your own social application keys here for each platform:
    • clientID
    • clientSecret
    • callbackURL

To run with a different environment, just specify NODE_ENV as you call grunt:

$ NODE_ENV=test grunt

If you are using node instead of grunt, it is very similar:

$ NODE_ENV=test node server

NOTE: Running Node.js applications in the production environment enables caching, which is disabled by default in all other environments.

Getting Started

We pre-included an article example, check it out:

More Information

Credits

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.