Giter Club home page Giter Club logo

schoolify-client's Introduction

Schoolify

You can view the deployed application here.

Table of Contents

Summary

A app that brings parents closer to their children’s school day.

Endless benefits for all parties involved. Business entities have moved their modeling process and communications online. Then why are schools (education centers) still so outdated with their approach?

This app works towards cutting green emissions, by reducing paper communication, and streamlining conversations between teachers and parents, this app also documents conversations and progress of children for future reference as a smart way of tracking progress.

A responsive dynamic app which will run in the browser. Schoolify is an easy to use application, which holds a Mongo database, and manages relations between parents, students and teachers. The website requires direct input from the user, where the user signs up and is easily able to navigate through the site. Teachers have different functionalities to what parents can do, through controlled routing.

User Story

AS a user I expect to FIND a main page that gives me an overview of what the app is about.

I would ALSO expect to find some form of navigation on using the app, such as 'signing up' and 'logging in' buttons,

WHEN i click on either buttons, i EXPECT to be taken to a page where i can either login and be relocated to a private page or enter my details and sign up for instant use.

As a PARENT i would THEN like to be taken to my dashboard. WHERE i can see my children, and HAVE the ability to add children.

I WOULD also like to have a navbar that would give me EASY access to the relevant pages, such as my requesting absences for my child, checking their STATUS. Adding medical information and having the ability to receive and RESPOND to incident reports.

As a TEACHER upon logging in i WOULD like to be navigated to MY classroom to see all my students. I WOULD like to have ACCESS to my students information for Medical and information purposes.

I would like to CELEBRATE achievements of my students, and share these milestones with their parents.

As a teacher i WOULD want the ability to notify teh parents of an incident report and receive confirmation from the parent that the message was understood.


As a SCHOOL i would like to have an audit trail of all conversations between parents and teachers, to protect both parties and teh school. We would also like to stream line our administration processes by giving the parent the ability to request absence for their child, and respond to them via the portal, this also protects the school via documenting leave for reporting purposes.

Technologies Used

Languages

  • HTML5
  • CSS
  • JavaScript
  • JQuery
  • MongoDB
  • GraphQL
  • Apollo
  • Sequelize

Frameworks used

  • Material UI
  • Material icons
  • Google Fonts
  • Node JS
  • Express JS
  • date-fns
  • npm-confetti
  • bcrypt
  • AWS

Installation:

If you are interest in making contribution to the code, you can install this repository by following the instructions below:

You are able to clone the repositories for the client and the server and then clicking on the code button. Select how you would like to clone the repository.

If you have your SSH keys set up, you are able to copy the link from the drop down and paste the following into your terminal application: (PLEASE NOTE: the client and the server should be created in separate repositories)

[email protected]:DMO17/schoolify-client.git
[email protected]:DMO17/schoolify-server.git

Then change your directory so you are now in your newly cloned projects and then open the code in your chosen source-code editor.

You need to install all dependencies that are listed in the package.json file:

npm install

How to run the application:

To run the start script, use the following code in the terminal.

Client:

npm run start

Server:

npm run dev

React:

React.js is a popular JavaScript library that is used to create graphical interfaces of web applications. Often used to create Single Page Applications, but it can also be the basis of mobile applications. Now, React.js is the most popular front-end JavaScript library for web development.

Notable features of React include components, which are are autonomous, reusable bits of code. They are used for the same use as JavaScript functions, but run in isolation and return HTML. React allows you to define components as classes or functions through properly implemented methods and inheritance. Each component has several lifecycle methods that you can override so that your code runs at a specific time in your program.

Contributors

Improvements

  • Giving the teacher the ability to take the register, and for attendance to be updated and tracked on teh parents side also
  • Giving the parent and teh teacher to track learning and behavior
  • ability to update medical records
  • Ability to give reason for rejected absence requests
  • Creating a premium service, gives packaged add-ons
  • adding a learning portal where parents can print the curriculum, and extra learning material.

References

Heroku

Apollo GraphQL

canvas-confetti

Flexbox positioning

date-fns

Webm to Gif converter

Mozilla.org

StackOverflow

License

MIT

This project is licensed under the terms of the MIT license.

Questions

  • If you have any questions about this project
  • would like further information
  • would like to report and issue

please contact me through the links below:

GitHub Profile

Email: [email protected]

schoolify-client's People

Contributors

dmo17 avatar fudge88 avatar lenny-g avatar luizfroes avatar surajverma2587 avatar tayyibm21 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.