scala-news-reader

rss/atom news reader in scala

git clone https://9o.is/git/scala-news-reader.git

README.md

(2037B)

      1 Twitter Bootstrap
      2 -----------------
      3 
      4 Bootstrap v2.2.2 is included.
      5 
      6 MongoDB
      7 -------
      8 
      9 This app uses MongoDB. Therefore, you will need to either have it installed locally, or use one of
     10 the cloud providers and configure it in your props file. See config.MongoConfig for more info.
     11 
     12 Building
     13 --------
     14 
     15 This app requires sbt 0.12. To build for the first time, run:
     16 
     17     bash$ sbt
     18     > ~;container:start; container:reload /
     19 
     20 That will start the app and automatically reload it whenever sources are modified. It will be running
     21 on http://localhost:8080
     22 
     23 Less
     24 ----
     25 
     26 The [less-sbt](https://github.com/softprops/less-sbt) plugin is used to compile the bootstrap less files as well as your own.
     27 
     28 * `src/main/less/styles.less` acts a manifest file that lists all of the other less files that are to be included in the build.
     29 * `src/main/less/variables.less` is for setting colors, fonts, etc.
     30 * `src/main/less/custom.less` is where you can add custom styles for your app.
     31 * `src/main/less/bootstrap` are the original files and should not be changed.
     32 
     33 You can also add other less files to the build by adding them to styles.less.
     34 
     35 **Note:** In order to trigger sbt to re-compile the less files, you need to save styles.less.
     36 
     37 JavaScript
     38 ----------
     39 
     40 The [sbt-closure](https://github.com/eltimn/sbt-closure) plugin is used to compile JavaScript files.
     41 
     42 * `src/main/javascript/script.jsm` is the JavaScript manifest file that lists all of the JavaScript files that are to be included in the build.
     43 
     44 **Note:** In order to trigger sbt to re-compile the JavaScript files, you need to save script.jsm.
     45 
     46 User Model
     47 ----------
     48 
     49 This app implements the [Mongoauth Lift Module](https://github.com/eltimn/lift-mongoauth).
     50 The registration and login implementation is based on
     51 [research done by Google](http://sites.google.com/site/oauthgoog/UXFedLogin) a few years ago
     52 and is similar to Amazon.com and Buy.com. It's different than what most people seem to expect,
     53 but it can easily be changed to suit your needs since most of the code is part of your project.