https://github.com/pratikpc/teachersportal
A Web App to Simplify Management of Educational Records and Publications for Teachers
https://github.com/pratikpc/teachersportal
ejs express heroku jquery nodejs postgresql sequelize sequelize-typescript teachersportal typescript
Last synced: 3 months ago
JSON representation
A Web App to Simplify Management of Educational Records and Publications for Teachers
- Host: GitHub
- URL: https://github.com/pratikpc/teachersportal
- Owner: pratikpc
- License: mit
- Created: 2020-04-20T09:23:12.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T18:25:06.000Z (almost 6 years ago)
- Last Synced: 2025-02-12T00:38:48.453Z (over 1 year ago)
- Topics: ejs, express, heroku, jquery, nodejs, postgresql, sequelize, sequelize-typescript, teachersportal, typescript
- Language: CSS
- Homepage: https://teachers-portal-pc.herokuapp.com/
- Size: 5.68 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Teacher's Portal](https://teachers-portal-pc.herokuapp.com/)
A [Simple Web App](https://teachers-portal-pc.herokuapp.com/) to simplify the management of an organization's teacher's educational and publication records on a simple server.
## Table of Contents
* [Description](https://github.com/pratikpc/TeachersPortal#description)
* [Installation](https://github.com/pratikpc/TeachersPortal#installation)
* [Prerequisites](https://github.com/pratikpc/TeachersPortal#prerequisites)
* [Instructions](https://github.com/pratikpc/TeachersPortal#instructions)
* [Usage](https://github.com/pratikpc/TeachersPortal#usage)
* [Members](https://github.com/pratikpc/TeachersPortal#Members)
* [TODO](https://github.com/pratikpc/TeachersPortal#TODO)
## Description
An Express EJS web application where college authorities can manage teachers and generate summaries of teacher activities over a decided perioid. Teachers can log their achievements like publications, conferences and researches in an organized manner.
This makes it easy for organisations to easily extract Employee Achievements
## Installation
### Prerequisites
* [Node.JS](https://nodejs.org/)
* [PostgreSQL](https://www.postgresql.org/)
By Default configured with Username = postgres and Password = Postgres.
Use this to [setup a Docker PostgreSQL environment](https://github.com/pratikpc/Docker-Common-Configs/blob/master/Postgres%20DockerStarter.bat)
### Instructions
#### Clone the repository
```
git clone https://github.com/pratikpc/TeachersPortal
```
#### Sample Environment
Modify [Sample Environment](sample.env) parameters to customize and link to other PostgreSQL solutions.
Rename and store the modified file as _.env_
#### Install and Build
```
npm install
npm run build
```
## Usage
Start the webapp
```
npm run deploy
```
Open a browser and go to [http://localhost:8000](http://localhost:8000)
## Members
* [Pratik Chowdhury](https://github.com/pratikpc)
* [Elivs Dsouza](https://github.com/ejson03)
* [Vedant Sahai](https://github.com/vedantsahai18)
## TODO
* Store All Metadata on Storage Solutions like [MongoDB](https://www.mongodb.com/)