QuietEvolver/BCAT

Online assessment and planning tool for community broadband organizers.

Development Info

All of the code for the project is current in the survey-app folder. This project is built using KeystoneJS. More specifically it uses Node.js, MongoDB, Express, Pug, Stylus and Bootstrap.

Dependencies

• Node.js / npm
  • https://nodejs.org/en/download/
• MongoDB
  • Mac: brew install mongodb
  • Windows
  • If this is your first time using MongoDB, you will also need to set up a /data/db directory with the correct permissions.
    • Mac and Windows Examples

Set up

• Clone the repository

  git clone https://github.com/will-saunders/BCAT.git
  cd BCAT/survey-app
  npm install
  

• Create a .env file with a cookie secret:

  echo "COOKIE_SECRET=<a_bunch_of_characters>" > .env
  

  For now, <a_bunch_of_characters> can be whatever you'd like.

• In a separate terminal start mongodb: mongod

• Run npm start

• Check localhost:3000

• Login to the admin page with username: user@keystonejs.com and password: pass

• Debugging should work out of the box with VSCode

Structure

BCAT/survey-app
|-- models
|-- public
    |-- styles
        |-- site
            |-- _layout.styl
            |-- _variables.styl
|-- routes
    |-- index.js
    |-- middleware.js
    |-- views
|-- templates
    |-- views

• models
  • this is where MongoDB models are defined, using keystone field types
• public/styles/site
  • _layout.styl and _variables.styl are the stylus files to override bootstrap defaults.
  • site.css and site.styl are generated, so any changes you make to them will be overwritten
• routes
  • this is the folder for express routing
  • new routes are added to routes/index.js
  • code for handling each new route should go under routes/views/<your_view>.js
  • to create a variable that's accessible by a pug template, save it as locals.varname, which will be varname in the pug template
• templates
  • this is the folder for pug templates
  • code for new pages go under templates/views/<your_view>.pug

Resources

Keystone Demo
Keystone Demo Repo
Keystone DB Documentation
Throttling Network w/Chrome DevTools