pyc-website

main website for pyc inc.

git clone https://9o.is/git/pyc-website.git

README.md

(1933B)


      1 Twitter Bootstrap
      2 -----------------
      3 
      4 Bootstrap v3.0.3 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 #Requirements
     13 
     14 * Grunt 0.4.x [http://gruntjs.com/](http://gruntjs.com/)
     15 
     16 #Install required components
     17 
     18 Install node using your operating system package management.
     19 
     20 Then: (you may need to run them as sudo)
     21 
     22 ```
     23 $ npm install -g grunt
     24 $ npm install -g grunt-cli
     25 $ npm install bower
     26 $ bower install jquery jasmine-jquery
     27 
     28 ```
     29 
     30 #Initial workflow
     31 
     32 Once you have the setup in place, we need to do the initial build of the resources (javascript, css anf font files). This is why we use `Grunt`. So go ahead and run this on the terminal:
     33 
     34 ```
     35 $ grunt
     36 $ ./sbt
     37 sbt> eclipse with-sources=true
     38 ```
     39 
     40 
     41 #Normal workflow
     42 
     43 While you are developing your application, you can run
     44 
     45 ```
     46 $ grunt watch
     47 $ ./sbt
     48 sbt> ~;container:start; container:reload /
     49 ```
     50 
     51 And this task will watch for changes on your css/js files and run the minification and concatenation automatically. This step may take some time. If the time it takes is too long, you could modify the `Gruntfile.js` file not to run the minification/uglifycation step during dev mode. Future versions of this template will provide that.
     52 That will start the app and automatically reload it whenever sources are modified. It will be running
     53 on http://localhost:8080
     54 
     55 User Model
     56 ----------
     57 
     58 This app implements the [Mongoauth Lift Module](https://github.com/eltimn/lift-mongoauth).
     59 The registration and login implementation is based on
     60 [research done by Google](http://sites.google.com/site/oauthgoog/UXFedLogin) a few years ago
     61 and is similar to Amazon.com and Buy.com. It's different than what most people seem to expect,
     62 but it can easily be changed to suit your needs since most of the code is part of your project.