Family Helper

Table of Contents

1. Description
2. Packages
3. Frameworks
4. Installation
5. To Do List

Description

A simple Node.js Express web server project for helping a family in everyday tasks.

First developed feature is sharing files locally across a network. Add some SSH functionality to this, and you will have your own storage system accessible from everywhere.

Feel free to mess around with the files, explore, and change the some names as you wish.

Please pull request any feature you want to add/fix/remove. Highly appreciated.

---

Packages

• Dependencies

  • express - For the main web server application.
  • express-formidable - Handling file uploads.
  • ejs - For EJS support (injecting data into client side).

• DevDependencies

  • @types/* - For typescript type checking
  • nodemon - For resetting the server automatically during development.
  • prettier - A beautifier
  • typescript - The builder for typescript files
  • tslint - The linter for the project
  • tslint-config-prettier - Linking prettier with the linter

---

Frameworks

• Bootstrap - For the styling/responsiveness of the website.
• Popper.js - A Bootstrap dependency needed for closing some alerts.
• jQuery - For navigation bar responsiveness and other styling purposes.

---

Installation

Must have Node.js, download it first then follow the steps.

1. Download/clone the repository

• If you have Git installed, simple go to a folder and type git clone https://github.com/GamesProSeif/family-helper.git in the terminal.
• Else download the repository as a zip and unzip it.

2. Open the file setup.bat to install the packages and start building the files.
3. Open the file start.bat to run the server. A link will be logged to the console to connect to the web server. If it fails to do so, type ipconfig in the terminal, and use your IPv4 address following the port number. EG 192.168.x.x:PORT.

Default port is 80 which is a known port for web servers, that lets you connect to the server by just mentioning the ip (192.168.x.xx).

 

---

To Do List

• General
  • User authentication
  • Night mode feature (dark screen)

• Sharing feature
  • Mutli-file upload support
  • Configuration file (for name, port, etc...)
  • Timestamp to file upload
  • Log file of uploaders/downloaders
  • Fix overflow when uploaded file name is long
  • Private Share
  • Size limiting

• Todo list feature

  • Add Todo list feature

• Messaging feature

  • Add Messaging feature

---

Copyright (c) 2019 GamesProSeif All Rights Reserved.