empirical-org-archive / quill-writer Goto Github PK

Issue by TGOlson
Sunday Jun 22, 2014 at 21:10 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#26

• Create simple lobby that displays games and their status.
• Allow users to create a new game.
• Allow users to join a game.
• Allow users to end/close a game.

Currently game links are pretty wide open and mapped directly to their firebase ids. Both these things are probably not ideal - later when we have actual users we may consider using the user id to track users within games.

See live deployment here.

Note: games are live data. See direct database data at firebase.

TGOlson included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/26/commits

Issue by wlaurance
Friday Jun 27, 2014 at 17:26 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#33

Connect assets will finger print the angular stuff and other files.

Perhaps there is a nice gulp way to write a var into index.jade?

@TGOlson Any experience with gulp + express + jade(or other server side templating)?

Issue by wlaurance
Tuesday Jun 10, 2014 at 20:57 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#18

Is there a reason why the node core crypto module isn't being use?

https://github.com/empirical-org/Stories-With-Friends/blob/master/package.json#L24

The only function I see being used is randomBytes which core crypto implements.

Issue by lpatmo
Saturday Jun 07, 2014 at 20:42 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#15

Committed JS solution to Issue #3 (added in "submit story to teacher" button)
Tweaked CSS to improve UX

lpatmo included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/15/commits

Issue by wlaurance
Wednesday Jul 09, 2014 at 15:55 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#39

Firebase is great because there are no schema restrictions, yet.

Firebase is potentially bad because there are no schema restrictions, yet.

Make notes to the structure we are using in the README.

The Forge area is perfect for looking at what is currently there, https://storieswithfriends.firebaseio.com/ (being a dev on the stories with friends team required to view)

Once we have a nice structure we like, we can write some firebase security rules that help limit the types of data that can be put in certain places. https://www.firebase.com/docs/security/security-rules.html

Issue by wlaurance
Wednesday Jul 09, 2014 at 14:54 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#37

Each game should be limited to two players.

I think we can just use $firebase().$on('loaded') event to wait for the array to load the current list of players.

There is still a race condition if more than two people try to get in the same game.

If this proves problematic, we can use a Firebase transaction.

Issue by petergault
Thursday Jul 10, 2014 at 20:37 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#43

By 12PM on Wednesday, July 16, we need 3 slides in a PDF format. We've wireframed these in the attached images and will supply you with the text and vocabulary words soon.

This is an urgent priority, so how we represent the website in these slides does not need to be the same as how the finished project will look. We are interested in highlighting the areas in slide 1 with the zoom filter mentioned earlier.

Google Drive folder for this project:

https://drive.google.com/a/quill.org/#folders/0B-r431ws0zjXdS1HSVhSRkpEWms

For your reference:
StoriesWithFriends.org (the site)
Quill.org (our main site)
https://www.youtube.com/watch?v=vgvPmvw8meY (SWF demo video)

Issue by RyanNovas
Wednesday Jun 25, 2014 at 01:54 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#31

Issue by wlaurance
Thursday Jul 24, 2014 at 16:09 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#45

The Form URL is used to create an Activity for Stories with Friends.

This can be a simple HTML form that collects the prompt, list of word/definitions, and the number of used words needed to complete the activity.

The Compass API only accepts JSON at the moment, so we will have to override the form action with some JavaScript to send the correct payload type.

Issue by wlaurance
Thursday Jul 24, 2014 at 21:02 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#47

These commits pertain to #45.

Follow on work is described in #46

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/47/commits

Issue by TGOlson
Sunday Jun 22, 2014 at 21:15 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#27

Right now the firebase database url is hardcoded to the production url. Ideally we would have a dev environment database when developing locally. I've never set up something like that using Firebase, so I'm not sure if that would entail using a shared dev database (not ideal, but simpler), or each developer using their own sandbox firebase instance (best option, but no clue how we would set that up).

Issue by petergault
Saturday Jun 07, 2014 at 13:56 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#2

Design update

Create requirements for the lesson. Use x number of words to pass lesson.

Share stories on a common spot.

Allow students to flag sentences.

Fixing bugs with the refresh.

Allowing teachers to upload lessons.

Creating strong documentation for the site.

Pulling data from EngangeNY

Pulling a mobile app with push notification

Advanced: hooking up the site to the API.

Advanced: creating a classroom specific lobby where students can jump into a match.
Ux options:

1. Teacher assigns student pairs.
2. Students are randomly assigned pairs.
3. Students create rooms and choose who to play with.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:18 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#5

For example, use X number of words to pass lesson.

Issue by petergault
Monday Jun 23, 2014 at 21:04 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#29

Stories With Friends is live at StoriesWithFriends.org. You can test out the UX by opening the site in two separate browsers and joining a match.

There are three projects to consider one:

1. How students are matched together.
   See the details here:
   https://docs.google.com/a/quill.org/document/d/1i27qMWzaBjDwuonyi3jIiHeY-O_yqiIrvu18oWZ4K7o/edit

2. Refining the experience of students playing the game.
   There are thee outstanding UX issues with the current game interface:
   Empirical-org-Archive/Quill-Writer-Archive#4
   Empirical-org-Archive/Quill-Writer-Archive#16
   Empirical-org-Archive/Quill-Writer-Archive#14

3. Showcasing all of the students accomplishments.
   See this issue: Empirical-org-Archive/Quill-Writer-Archive#6

Issue by RyanNovas
Wednesday Jun 11, 2014 at 14:53 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#20

Goal: We need a database so that we can add additional content. It should probably be PostGres or MongoDB.

Content will include additional lessons composed of vocab words, prompts, definitions, and win points (e.g. 6/10 words used).

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:21 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#6

Goal: Publicly display all submitted lessons within a classroom.

How: These lessons should be displayed after a student submits their story, as outlined in issue #3. This will require classroom lobbies to be set up and API Integration #11

Issue by petergault
Thursday Jul 10, 2014 at 20:43 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#44

This is not as urgent, but will need to be finished in about a month so that we can get the design live in time for the school year.

Storieswithfriends.org has virtually no design in its current iteration and we want to fix that. We'd like it to be fairly imaginative and playful, but because it is meant for middle and high schoolers, not overly juvenile.

Issue by wlaurance
Wednesday Jul 30, 2014 at 15:59 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#48

The module url is to remain /#/

As of now, the app takes in the Query String params and redirects to /#/games

We should drop the Redirect and only use /#/

It uses the redirect for testing locally. Eventually we the iFrame integration is complete, we can test through that avenue.

Issue by wlaurance
Tuesday Jun 10, 2014 at 21:01 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#19

Closes #18

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/19/commits

Issue by TGOlson
Monday Jun 23, 2014 at 01:31 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#28

Likely karma for the angular unit tests. Might consider some other test framework for end-to-end tests, if desired.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:27 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#11

Note: This is our first pass at explaining our brand new and barely documented API. We'll need to work with you to make sure this is clear and to ensure that our API documentation makes sense. Our lead developer can help you with this.

Goal: Integrate Stories with Friends (SWF) with the Compass API (https://github.com/empirical-org/Compass-API) so that lessons/grades will show up in Compass, our learning management system.

How: The Compass database contains lesson names and descriptions. Students and teachers see these without visiting SWF. The SWF database will contain the actual content (i.e. vocab words, definitions, and prompts). These need to be linked together, and then the MatchID and PlayerID variables need to be linked to the specific students and classrooms that they came from in Compass.

Issue by wlaurance
Wednesday Jul 09, 2014 at 19:21 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#41

Each user will make a Compass API request to get their information.

I have stubbed the method, see #40, but I'm not going to use it at the moment. I'm unsure what what this data will look like and even how to tell who is who.

@quinn Will both players get the same uid and sid?

Issue by wlaurance
Tuesday Jul 08, 2014 at 17:41 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#36

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/36/commits

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:13 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#3

Goal: Change "Submit" button to "Submit Story to Teacher" button, after all vocab words have been crossed off.

How: The current submit button should change to "Submit Story to Teacher" once all words in the list have been used. Ultimately this should direct users to the public page in isssue #6, but as we don't actually have anywhere for this to go right now, so it can just return to homepage until we figure that out.

Issue by wlaurance
Thursday Jun 19, 2014 at 14:53 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#22

@TGOlson When I make a make a fresh clone && bower install, I do not get the bootstrap.css style sheet.

Is this something that should be added into bower.json?

Issue by wlaurance
Friday Jun 27, 2014 at 17:54 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#34

Serves the angular app from heroku.

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/34/commits

Issue by wlaurance
Wednesday Jul 30, 2014 at 20:52 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#50

This PR will cross off the words as they are used.

It uses Firebase references, so it is synced in real time to each student.

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/50/commits

Issue by angelawyman
Wednesday Jun 25, 2014 at 01:41 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#30

When students finish stories they get notebooks. Which would then go into a library for the class.

Issue by wlaurance
Tuesday Jun 10, 2014 at 20:41 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#17

http://www.jshint.com/
https://github.com/einars/js-beautify
https://github.com/rdio/jsfmt

And embrace https://github.com/rwaldron/idiomatic.js/ or something similar

Issue by TGOlson
Sunday Jun 22, 2014 at 02:02 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#25

We should put a build tool in place for compiling, concatenating, minifying, etc. our script and style files.

I've used gulp before with good success, and have dabbled enough with Grunt to know that works well too. Any preferences would be good to hear.

Issue by wlaurance
Wednesday Jul 09, 2014 at 15:48 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#38

Using Firebase two players are able to talk to each other.

There is a placeholder for the words to be used.

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/38/commits

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:26 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#10

Issue by wlaurance
Friday Jun 27, 2014 at 15:11 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#32

We will target Heroku for now.

Issue by spacez320
Monday Jun 16, 2014 at 22:33 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#21

Rebranding for empirical-org/Stories-With-Friends and removing dependencies that weren't used anywhere.

spacez320 included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/21/commits

Issue by wlaurance
Wednesday Jul 30, 2014 at 16:11 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#49

This PR shows which student's turn it is and uses the firebase properties to make the switch happen.
Thanks to angular, all we have to do is switch a boolean value and the app updates accordingly.

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/49/commits

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:17 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#4

Goal: Students should be able to flag sentences for the teacher to review

Issue by wlaurance
Thursday Jul 24, 2014 at 21:00 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#46

This will require using OAuth and me researching how this works and translating to angular.

Issue by RyanNovas
Tuesday Jun 10, 2014 at 16:28 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#16

Goal: Create win condition that serves as finish point for activities.

How: X words from the word bank must be used to complete the activity. A counter should be displayed below the word bank, as shown here;

When the minimum count is reached, the button created in solution #15 should display. When this is clicked, the story should be submitted to the teacher and publicly posted in the classroom lobby.

Issue by wlaurance
Wednesday Jul 09, 2014 at 19:36 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#42

This allows game logic to continue while another developer works on the Compass API portion of Stories with Friends.

wlaurance included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/42/commits

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:26 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#9

Ryan will get about 5 lessons of approximately 10 words each from Engage NY. These will be sorted by grade and form the content.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:29 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#13

Issue by TGOlson
Sunday Jun 22, 2014 at 01:57 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#24

Initialize firebase.json config file. (currently our public directory is src, but that should change once we implement a build tool)

Update README with live site link.

Commit src/vendor scripts. I couldn't find a way to run bower install postinstall on firebase hosting, so I decided to commit the vendor scripts. Hopefully we can find a better solution.

TGOlson included the following code: https://github.com/empirical-org/Quill-Writer-Archive/pull/24/commits

Issue by petergault
Saturday Jun 21, 2014 at 19:09 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#23

Students are confused about whether they can use the past tense of a word. SWF does accept past tense verbs, and we need to tell students they can use an alternate tense.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:29 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#12

Ux options:

1. Teacher assigns student pairs.
2. Students are randomly assigned pairs.
3. Students create rooms and choose who to play with.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:24 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#7

This is dependent on #11 being completed.

Teachers should be able to upload their own word lists, prompts, and definitions via a csv file.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:25 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#8

Goal: Make the site structured and documented well enough that people can easily jump in and start coding.

Why: Stories With Friends was written in one day, so the code can be messy in some areas. However, it is an open source project, and we want contributors to be able to easily jump in and understand what is going on. This will save time in getting set up, increase accessibility, and save us time that may otherwise be spent explaining.

How: Go through code and clean it up. The original creator, Leo, should be able to help with this.

Issue by RyanNovas
Saturday Jun 07, 2014 at 16:51 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#14

Goal: The person whose turn it is to write should be clearly indicated.

How: Every time one user hits submit, the bolded name should switch to the opposite partner. In addition, if it is player1's turn to write, then player2 should be notified that player1 is writing next to player2's submit button.

Issue by wlaurance
Monday Jul 07, 2014 at 17:45 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#35

We need to to identify the URLs for Stories with Friends as specified here, https://github.com/empirical-org/Documentation/blob/master/Compass/API-Design/API%20Docs.md#activity-specification

Issue by petergault
Saturday May 31, 2014 at 05:04 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#1

Goal: Every time either student hits submit, the page should update with the segment of the story they added. Currently this does not always happen and students must sometimes manually refresh the page to reflect the changes.

Issue by wlaurance
Wednesday Jul 09, 2014 at 18:07 GMT
Originally opened as Empirical-org-Archive/Quill-Writer-Archive#40

Make a stubbed out version of the Angular Compass API