Skip to content

Commit

Permalink
edited readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PeanutBrrutter committed Sep 13, 2024
1 parent 0dbb98f commit 95f02ca
Show file tree
Hide file tree
Showing 15 changed files with 61 additions and 10 deletions.
Binary file modified EduSync.exe
Binary file not shown.
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
# EduSync
# EduSync

EduSync is a centralised web platform designed to streamline educational management processes at NK Robotics. It consolidates functionalities for lesson material storage and student media management into a single, secure, and user-friendly interface. The application provides tailored interfaces for students, parents, instructors, and admins, ensuring each user role has access to the specific tools and resources they need to enhance efficiency and improve the overall learning experience.


## Table of Contents

- [Features](#features)
- [Technologies Used](#technologies-used)
- [Screenshots](#screenshots)
- [Contributions](#contributions)


## Features

- **Centralised Resource Management**: The application provides a unified platform for storing and accessing lesson materials and student media, eliminating the chaos of managing multiple file locations and platforms.

- **Role-Based User Interfaces**: Tailored interfaces for different user roles - students, parents, instructors, and admins - ensure that each user group has access to the tools and resources relevant to their needs. This design simplifies navigation and improves the user experience.

- **User-Friendly Platform**: The web application is built with a focus on the ease of use, ensuring that all users can navigate the platform efficiently.


## Technologies Used
- [Go](https://golang.org/) - A statically typed, compiled programming language.
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) - The standard markup language for creating web pages.
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) - A stylesheet language used to describe the presentation of a document written in HTML.


## Screenshots

### Homepage
![Homepage](assets/images/home-page.png)

### Login Page
![Login Page](assets/images/login-page.png)

### Student Page
![Student Page](assets/images/student-page.png)

### Parent Page
![Parent Page](assets/images/parent-page.png)

### Instructor Page
![Instructor Page](assets/images/instructor-page.png)

### Admin Page
![Admin Page](assets/images/admin-page.png)


## Contributions
Jiawei and Jeyvian from Ngee Ann Polytechnic, Diploma in Cybersecurity and Digital Forensics, for our capstone project in Year 3.1, with guidance from our capstone teacher, Mr Benjamin Low.
Binary file added assets/images/admin-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/home-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/instructor-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/login-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/parent-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/student-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions database.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"fmt"
"log"
"net/http"

"os"
"strings"

Expand Down
18 changes: 9 additions & 9 deletions firebase.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ import (
"log"
"os"

"github.com/joho/godotenv"
//"github.com/joho/godotenv"

firebase "firebase.google.com/go"
"google.golang.org/api/option"
)

// Use godot package to load/read the .env file and
// return the value of the key (for local env)
func goDotEnvVariable(key string) string {
// func goDotEnvVariable(key string) string {

// load .env file
err := godotenv.Load(".env")
// // load .env file
// err := godotenv.Load(".env")

if err != nil {
log.Fatalf("Error loading .env file")
}
// if err != nil {
// log.Fatalf("Error loading .env file")
// }

return os.Getenv(key)
}
// return os.Getenv(key)
// }

// InitializeFirebase initializes the Firebase app and sets the global firebaseClient variable
func initializeFirebase() error {
Expand Down
Binary file added image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 95f02ca

Please sign in to comment.