savionguyen / bet_shalom Goto Github PK

This application was developed for Bet Shalom Congregation as part of a group project at Prime Digital Academy. From requirements gathering through deployment this project was completed in three weeks by students:

Remy Allen: https://github.com/remyallen

Bennett Batzli: https://github.com/BennettBatzli

Savio Nguyen: https://github.com/savionguyen

John Rachuy: https://github.com/johnrachuy

Josh Sternberg: https://github.com/JoshuaSternberg

##Who Bet Shalom Congregation is and how they are using this application Bet Shalom Congregation is a Reform Jewish congregation located in Minnetonka, Minnesota. Their religious school is committed to working together with all families to create a safe and positive environment for children to learn and grow in their Jewish faith. The Bet Shalom Religious School meets twice a week; Sunday morning and Wednesday evening. The teachers work full-time outside of school and volunteer their time as a way to give back to the community. This application allows admins and teachers to create lesson plans and share them with each other. This will save time for everyone by allowing them spend more time teaching rather than building brand new lesson plans every week.

##How this applications works Here is a quick walk through with some screen shots to give you a better idea of how everything works.

##Login Page This is the login page. The user enters their email address and password to gain access to the site. If they can't remember their password they can easily request a password reset by pressing the forgot password button. The user is sent an email to verify their identity and directed to a page to set a new password and login. ##Admin Dashboard This is the homepage for anyone logging in with admin credentials. Upon logging in the admin is greeted with a list of lesson plans that have been submitted for approval. All lesson plans created must be approved by an admin before they are searchable by other users.

##Create Lesson Plan When a user goes to the create lesson plan page this is what they will see. The first thing is to select if this will be a lesson plan or a resource. The ability to add resources is an admin only feature and will only appear if an admin is logged in. There is a field to enter a lesson title, the author is automatically populated based on the logged in user, a dynamic typahead of different searchable tags, a materials field to put any required items needed to do this particular lesson, a large text area for the plan itself and a choose file button to upload files/images into the lesson plan.

The admin has the ability to edit any submitted lessons before publishing. If there's something small they want to change they can easily do this right from here. If there's something more major they can add a comment and send it back to the teacher as needs review. Upon pressing the publish button a modal pops up to verify the action. Modals are used throughout the site to give the user feedback on requests.

##Manage Users The manage users page is only accessible by users logged in with admin credentials. Here an admin can add new users and edit existing ones. When a new user is created they are sent and email with a link which will bring them to the site allowing them to set a password and login. ##Teacher Dashboard This is the homepage for teachers logging in to the application. On the left, teachers can easily see the lesson plans they have created and the status of those plans. On the right, they can see any lessons they have marked as a favorite. ##Search This is the search page. The search page uses the same dynamic typahead that is on the create lesson plan page. Users can quickly search for lesson plans by typing in a subject, holiday or grade. There are 46 searchable tags with most lesson plans containing multiples of these tags. ##Published Lessons / Favorites / Comments When a lesson is selected this is what the user will see. Notice that nothing is editable on a published lesson plan. From this view teachers can favorite lesson plans by clicking on the star next to the title as well as leave feedback by clicking the Use Lesson Plan checkbox.

##File Upload Here is a closer look at our file upload feature. Hebrew text is not easily typed on a normal keyboard which is what made this feature so crucial to the application. A user making a lesson can simply press the choose file button in the lower left of the create lesson plan page. Upon pressing this button a finder window appears allowing the user to select the file they wish to add to the lesson plan. Pressing the upload file button brings that selected file into the lesson plan placing that file/image just under the lesson plan text area.