Code Monkey home page Code Monkey logo

bracketeer's Introduction

Twitter Bootstrap

Bootstrap v3 is included.

MongoDB

This app uses MongoDB. Therefore, you will need to either have it installed locally, or use one of the cloud providers and configure it in your props file. See config.MongoConfig for more info.

A docker-compose.yml file is included if you're using docker-compose.

Building

This app requires sbt. To build for the first time, run:

bash$ sbt
> ~;container:start; container:reload /

The alias ccr is provided so you don't have to remember that.

That will start the app and automatically reload it whenever sources are modified. It will be running on http://localhost:8080

sbt-web

sbt-web and associated plugins are used to handle JavaScript, LESS, and font files.

WebJars

WebJars are used to retrieve the jQuery and Twitter bootstrap dependencies.

User Model

This app implements the Mongoauth Lift Module. The registration and login implementation is based on research done by Google a few years ago and is similar to Amazon.com and Buy.com. It's different than what most people seem to expect, but it can easily be changed to suit your needs since most of the code is part of your project.

BrowserSync

Requires: NodeJS

The sbt build includes a browserSync task that will update a file every time the xsbt-web-plugin reloads. This is used in conjuction with the simple node script in the bs folder.

To use, first start the xsbt-web-plugin using the following command:

sbt> ~ ;container:start ;container:reload / ;browserSync

Or, use the provided alias ccrs.

Then, in a separate terminal, go to the bs directory and run:

bash$ npm install bash$ node bs.js

Once that's running it will display the port that you need to point your browser to, default is 3000.

Now, any time any changes are made and the container reloads, the browser will automatically reload as well. It will also reload when any .html files are changed.

Note: this was put in the bs directory because having a package.json file in the top directory caused problems with sbt-web.

Packaging

The package task will package the app into a WAR file. The warPostProcess function handles creating an SHA-1 digest of each asset file and renames them with the digest. The Assets snippet handles figuring out what the digest is for each file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.