Skip to content

sarahwalther/project_one

Repository files navigation

Progress Notes

It can be very tricky for special ed teachers to keep track of the daily progress students are making with the limited time there is available. Here is a quick way of adding a line or two about the way the day went for teachers.

Picture of School

User Stories

Project Sprint

As a teacher (user)...

  1. I can log in with LinkedIn.
  2. I can log out.
  3. when I log in, the application will use my LinkedIn profile to set my job title.
  4. I can see a list of student-rooms I have access to.
  5. I can create student rooms (including setting his/her goals).
  6. I can see a list of other teachers.
  7. I can give access to a room for a teacher.
  8. when I am in a student-room, I can see the student's goals.
  9. when I am in a student-room, I see a list of messages about the student.
  10. I can create time stamped student progress entries (messages).
  11. I can delete my own messages.
  12. I can edit, add. or remove a goal after I created a student
  13. I can rate a student's behavior

Icebox

  1. I can search the messages by user and date.
  2. I can see uploaded visual aids and other graphic information. (make this more explicit)
  3. I can comment on other teachers' messages.
  4. I can filter by tags that may have been added to the comments (ex: behavior).
  5. Issues to work out if there's time:
  6. student input to First Last name to save it as first_last
  7. add teachers by email address, not last name

API and Gems used

  • LinkedIn API - to log in to the app through an outside provider
  • Redis Gem - to use the Redis database to store information
  • Sinatra Gem - a web framework to build the skelleton of the app
  • HTTParty Gem - to access the LinkedIn API
  • JSON Gem - to translate from and to Ruby
  • Sinatra-Contrib Gem - to add Sinatra Reloader and other items

Instructions to run this App locally

Clone the Repo and cd into it

$ git clone [email protected]:sarahmcalear/project_one.git
$ cd project_one

To run this App, a LinkedIn API key is required. Click here to learn how to get the API key

Now install the required Gems and boot up your Redis server and start you app in separate Terminal windows

$ bundle install
$ redis-server
$ rackup

Releases

No releases published

Packages

No packages published