svametcalf/jbar

Juneau backcountry accident reports

jbar's Issues

Requirements (master issue)

This is a master issue to keep track of requirements for this app.

Overall purpose

This app is supposed to be a compendium of accident reports for accidents that happen in Juneau. This app is built with the goal of public education and transferring knowledge about mistakes and lessons learned from accidents in the backcountry.

Existing examples

• Accidents in North American Mountaineering

Basic use cases

• Public should be able to read accident reports for accidents that happen in the backcountry around Juneau
• Users should be able to create and edit their own accident reports, with input from content administrators / reviewers
• Public should be able to see a map of where reports are written about

Technical Specifications

This app should be as simple to build and run as possible. Here is a list of the anticipated technologies:

• Docker / docker-compose, for dev env and running in production
• Some sort of document based NoSQL DB, such as CouchDB
• EmberJS for frontend
• Markdown for rich text markup

Things that need to happen now:

• Develop technical requirements and specs (#2)
• Setup development environment (#3)
• Develop data model (ie list of questions that will be asked when users submit reports, authentication schemes, how to deal with images/ videos, etc) (#4)
• Implement data model in backend (#5)
• Implement front end. (#6)

Implement data model in backend

After requirements for #4 are complete, we need to implement them.

Implement front end

Develop a placeholder webpage and deploy

We need a placeholder page for our domain name (junueaubackcountryaccidents.org).

This page should describe:

• the aim of the project
• what will be there
• how does someone get involved

Setup development environment

Issue to discuss requirements and issues with development environment.

Develop technical requirements and specs

Issue to discuss technical specifications.

General Thoughts

I would like this app to require as few pieces as possible. To do this, I believe the simplest stack will be:

• A NoSQL database for storage. This allows us to be relatively freeform about how our reports are stored, but can enforce more structure than a straight up text document.
• A Single Page App framework for the frontend. Because of the map component, lets just use JavaScript throughout.
• Mechanism for hosting/serving data and frontend code

Needs/ Wants for SPA framework

• Talks to REST API
• Bootstrap Compatible
• Reusable Components
• Nice developer experience

Alright, you caught me. I was just making up requirements that EmberJS meets. I like it and it seems to work, so I think we should use it.

Needs/ wants for NoSQL DB

I am less opinionated about this one. There are a lot out there, and it will probably be a lot of time to evaluate all of them.

Needs:

• Needs to talk to Ember, using some REST system, preferably, without another application in the way
• Needs to handle authentication and authorization for users
• Needs to handle binary files in some fashion.
• Would be nice if compatible with Docker

Candidates:

• CouchDB
• Any others?

Thoughts on hosting / operations

DOCKER !!!!!
and nginx.

Develop data model

This issue should encompass issues such as:

• list of questions that will be asked when users submit reports
• authentication schemes
• how to deal with images/ videos
• etc