Gametrunk is a web application that allows users to challenge one another to games. The application keeps track of rankings and allows users to view profile info, stats, etc. It is designed to facilitate office-type competitions, where employees can challenge one another for positions on a ranking system.

This app is based on the SEAN Stack.

• PostgreSQL 9.4 or MySQL, MariaDB, SQLite and MSSQL (Depending on your project but SEAN.JS defaults to PostgreSQL 9.4)
• Redis Server
• Node.js (v6.3.1)
• NPM
• Grunt

$ git clone https://github.com/gametrunk-team/gametrunk.git

$ cd gametrunk

$ sudo npm install -g bower

$ sudo npm install -g grunt-cli

$ sudo npm install

$ bower install --allow-root

$ node server.js

After the install process is over, you'll be able to run your application using Grunt, just run grunt default task:

$ grunt

Your application should run on port 3000 with the development environment configuration, so in your browser just go to http://localhost:3000

That's it! Your application should be running. To proceed with your development, check the other sections in this documentation. If you encounter any problems, try the Troubleshooting section.

• explore config/env/development.js for development environment configuration options

To run your application with production environment configuration, execute grunt as follows:

$ grunt prod

• explore config/env/production.js for production environment configuration options

Application will start by default with secure configuration (SSL mode) turned on and listen on port 8443. To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:

$ sh ./scripts/generate-ssl-certs.sh

Windows users can follow instructions found here. After you've generated the key and certificate, place them in the config/sslcerts folder.

Finally, execute grunt's prod task grunt prod

• enable/disable SSL mode in production environment change the secure option in config/env/production.js

You can run the full test suite included with SEANJS with the test task:

$ grunt test

This will run both the server-side tests (located in the app/tests/ directory) and the client-side tests (located in the public/modules/*/tests/).

To execute only the server tests, run the test:server task:

$ grunt test:server

And to run only the client tests, run the test:client task:

$ grunt test:client

• Adam Stone
• Bailey Reed
• Jack Mertens

(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.