https://github.com/kpoptrashblaenk/phisher
This is totally not a phishing simulator.
https://github.com/kpoptrashblaenk/phisher
api phishing school-project
Last synced: about 2 months ago
JSON representation
This is totally not a phishing simulator.
- Host: GitHub
- URL: https://github.com/kpoptrashblaenk/phisher
- Owner: kpoptrashBlaenk
- Created: 2024-11-05T12:15:13.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-02-26T14:09:59.000Z (3 months ago)
- Last Synced: 2025-02-26T15:23:54.399Z (3 months ago)
- Topics: api, phishing, school-project
- Language: JavaScript
- Homepage:
- Size: 839 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Phisher**
_This is totally not a phishing simulator that sends phishing emails to chosen people and and tracks if those idiots fell for it._
## **Table of Contents**
1. [Features](#features)
2. [Gmail SMTP Server](#gmail-smtp-server)
3. [Installation](#installation)
4. [Database Schema](#database-schema)
5. [Routes Schema](#routes-schema)
6. [Run and Test](#run-and-test)
7. [Technologies Used](#technologies-used)
---
## **Features**
- Only administrators have access!
- Send emails to employes and track their behaviour!
- Choose one out of multiple templates to send!
- Access to a log of all the actions!
## **Gmail SMTP Server**
1. Create gmail account
2. Activate 2-Factor Security
3. Add App Password
4. Use App Password in SMTP in .env in next step
## **Installation**
1. Clone the repository:
```cmd
git clone https://github.com/TotallyNotAPhishingSimulator/Phisher.git
cd Phisher
```
2. Install dependencies:
```cmd
npm install
```
3. Set up environment variables and fill it out.
```cmd
copy env.template .env
```
4. Set up the database.
```cmd
npm run migrate
```
## **Database Schema**
## **Routes Schema**
## **Run and Test**
- **Start the Express server:**
```cmd
npm run start
```
- **Run Jest tests:**
```cmd
npm run test
```
## **Technologies Used**
- **Typescript / Javascript** – Language
- **Bootstrap** – CSS
- **Express.js** – Backend server
- **Node.js** – Javascript runtime
- **PostgreSQL** – Database
- **Nodemailer.js** - Emails
- **Bcrypt / Cookie-Parser / Jsonwebtoken / Password-Validator** - Authentication
- **Jest / Supertest** - Testing