psu-capstone / churchill

Other
2 stars 2 forks source link

Build Status

Churchill

Version 2.0

Folder Structure:

lib:

Unzip c3.zip. This is a modified c3 library that will show popups in Chrome. This can be removed once the pull request is completed to fix this issue in Chrome.
Update: This pull request has been merged to the c3 repo, watch for c3 version 0.4.11 release to fix this issue
If it is needed: after running npm install you will have to run npm link lib/c3 which may require admin rights to complete the link. When that is finished, var c3 = require('c3') in index.js will now look to lib/ instead of node_modules/c3

public/build:
After running the build.sh script, the deliverable will be located here.

public/dev:
Development folders, do normal work here.
It's certainly easier to see your changes if you use index_dev.html instead of running the build script every time. In this case, just click your desired browser icon in the upper right of index_dev.html. You will just see the popup error in Chrome again since you're using the c3 CDN again. You will also have to comment out var c3 = require('c3); in appController.js.


Deploy:

deploy/build.sh Production build script that executes the relevant production gulp tasks.

deploy/run.sh Script to start production web server

deploy/build_dev.sh
Development build script that tackles all the necessary gulp tasks and leaves you with a localhost:3000 server where you can directly view the application.


Miscellanous Files:

package.json
The necessary packages for this project. After cloning the repo npm install will pull the dependencies listed here.

gulpfile.js
Probably doesn't need to be modified but if you find something else cool gulp can do to make the code more efficient feel free to edit and try it out, just make sure all gulped files are routed to public/build. Note that this basically replaced the old server.js file that is no longer in the repo.

travis.yml
Continuous integration. Travis Churchill Page


Creating an Admin Account:


An admin is stored in the database with the tag is_admin: true value. To add an admin, you will have to hard code this into the issue_args in self.adduser.... By default, creating a user from the application will give a user is_admin: false.