Skip to content

Commit 57fb15b

Browse files
authored
Revise README with new project details and features
Updated project description, features, and technical stack in README.
1 parent 45fe62c commit 57fb15b

1 file changed

Lines changed: 95 additions & 29 deletions

File tree

README.md

Lines changed: 95 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,135 @@
1+
12
# NousInt
3+
<img width="1656" height="312" alt="Untitled (530 x 100 px)(2)" src="https://github.com/user-attachments/assets/52578880-c5fe-46ce-a9c9-310b6bf5cf00" />
24

3-
Derived from the classical concept of Nous, “intellect and direct awareness,” NousInt is designed to provide clarity within the noise of the web.
5+
> Derived from the classical concept of Nous, “intellect and direct awareness,” NousInt is designed to provide clarity within the noise of the web.
46
57
**NousInt is a curated catalog of OSINT and OPSEC resources, bringing reconnaissance tools, threat intelligence feeds, and privacy focused playbooks in one organized platform.**
68

7-
We also have our own articles, a PII scanner, and multi modal deepfake scanner :D
9+
We also have a multi-modal PII scanner, multi _model_ deepfake scanner, and our own articles :D
810

911
This is an open source and ongoing project by bellobyte.
1012
Art Credits: Inko Ojamist
11-
Created: January 2026
12-
Last Modified: Feb 18 2026
13-
# GWC Challenge
13+
**Created**: January 2026
14+
**Status**: Initial development done. Now adding more tools, making a video for the placeholder, trying to make tool db easier to manage with markdown, finding new features to add, organizing topics to cover in articles like physical counter surveillance tactics/threat analysis/other stuff.
15+
16+
17+
### 🌐 **Live Site**: [nousint-cd55bda4eead.herokuapp.com](https://nousint-cd55bda4eead.herokuapp.com/) (soon to be nousint.app c:)
18+
19+
# 📋 Table of Contents
20+
21+
- [Features](#-features)
22+
- [Showcase](#showcase)
23+
- [GWC Challenge](#gwc-challenge)
24+
- [Technical Stack](#technical-stack)
25+
- [Local Development](#local-development-optional)
26+
- [Contributing](#-contributing)
27+
- [Disclaimer](#disclaimer)
28+
- [License](#license)
29+
30+
## ✨ Features
31+
32+
- 🔍 **OSINT Catalog** - Curated collection of reconnaissance and intelligence gathering tools
33+
- 🛡️ **OPSEC Resources** - Privacy-focused tools and defensive security resources
34+
- 🤖 **AI Deepfake Detection** - Multi-model/modal scanning using Gemini AI, SightEngine, and HuggingFace models
35+
- 📝 **Security Articles** - Educational content on OSINT, OPSEC, and AI threats
36+
- 🎨 **Dual Themes** - Blue (defensive) and Red (offensive) interface modes
37+
- 🔒 **Privacy-First** - No data collection, all scans processed in real-time
38+
39+
# Showcase
40+
<img width="1917" height="906" alt="image" src="https://github.com/user-attachments/assets/3bc52713-fa99-4dad-962d-c30329ce1bc7" />
41+
<img width="1845" height="937" alt="image" src="https://github.com/user-attachments/assets/a5c9b6ee-7204-4294-88ef-40f1b3508026" />
42+
43+
44+
<sub> And yes, I used AI to help a lot with advanced topics. It's pretty obvious, and I am not hiding it because I still learned and applied my knowledge from web security courses and programming classes! And who knew that integrating apis and deploying websites wasn't that hard all this time? not me :D </sub>
45+
46+
# 💚 GWC Challenge
1447
This project addresses the GWC **Cybersecurity + AI Challenge** theme:
1548

1649
- **Problem**: AI-generated deepfakes threaten identity and trust, and many social media posts expose user PII which threaten user privacy. There is also lack of OSINT knowledge due to lack of structured knowledge bases.
1750
- **Solution**: Use AI and a catalog of resources to detect and protect against AI-generated threats, from automated OSINT tools to mass surveillance, as well as human threat actors.
1851
- **Impact**: Empowers users to verify media authenticity before sharing, and protect their privacy through education!
19-
# Installation
52+
53+
## Technical Stack
54+
55+
- **Backend**: FastAPI, Python 3.11, Uvicorn
56+
- **AI Services**: [Google Gemini 2.5 Flash](https://docs.cloud.google.com/vertex-ai/generative-ai/docs/models/gemini/2-5-flash), [SightEngine](https://sightengine.com/detect-ai-generated-images), [HuggingFace: Organika/sdxl-detector](https://huggingface.co/Organika/sdxl-detector)
57+
- **Frontend**: Vanilla JavaScript, CSS
58+
- **Content**: Markdown with Obsidian callouts support
59+
- **Security**: File validation, MIME type checking, rate limiting (slowapi)
60+
- **Deployment**: Heroku
61+
62+
## Local Development (Optional)
63+
64+
The site is live at [nousint-cd55bda4eead.herokuapp.com](https://nousint-cd55bda4eead.herokuapp.com/), but if you'd like to run it locally or contribute:
2065

2166
1. Clone the repository:
2267
```bash
23-
2468
git clone https://github.com/bellobyte/NousInt.git
25-
2669
cd NousInt
27-
2870
```
2971

3072
2. Create a virtual environment and install dependencies:
3173
```bash
32-
3374
python3 -m venv venv
34-
3575
source venv/bin/activate
36-
3776
pip install -r requirements.txt
38-
3977
```
4078

4179
3. Set up environment variables:
42-
Copy the example environment file to create your own `.env` file:
43-
```bash
44-
45-
cp .env.example .env
46-
80+
Create a `.env` file with your API keys:
81+
```env
82+
RIZZ_KEY=your_gemini_api_key
83+
SIGHTENGINE_API_USER=your_sightengine_user
84+
SIGHTENGINE_API_SECRET=your_sightengine_secret
85+
HF_API_KEY=your_huggingface_key
4786
```
48-
Open `.env` and fill in your API keys (Gemini, SightEngine, HuggingFace).
4987

5088
4. Run the application:
5189
```bash
52-
5390
python main.py
54-
5591
```
5692

5793
5. Navigate to http://localhost:5000
5894

59-
# Showcase
60-
<img width="1917" height="906" alt="image" src="https://github.com/user-attachments/assets/3bc52713-fa99-4dad-962d-c30329ce1bc7" />
95+
### 📁 Project Structure
96+
97+
```
98+
NousInt/
99+
├── main.py # FastAPI application & routes
100+
├── templates/ # HTML templates (Jinja2)
101+
├── static/
102+
│ ├── css/ # Stylesheets (dual theme support)
103+
│ ├── js/ # Frontend logic, catalog data
104+
│ ├── images/ # Logos
105+
│ └── vendor/ # Font Awesome icons
106+
├── articles/ # Markdown articles
107+
├── requirements.txt # Python dependencies
108+
└── Procfile # Heroku deployment config
109+
```
110+
111+
## 🤝 Contributing
112+
113+
Contributions are welcome! Whether it's:
114+
- Adding new tools
115+
- Writing articles
116+
- Improving security
117+
- Fixing bugs or improving UI/UX
118+
- Suggesting features
119+
120+
Feel free to open an issue, post a discussion, or submit a pull request!
121+
122+
## Disclaimer
123+
124+
This project catalogs security tools for educational and research purposes. Many of these tools can be used for both defensive security (protecting systems) and offensive security (penetration testing).
125+
126+
**Users are responsible for ensuring their use of any cataloged tools complies with applicable laws and regulations.** Unauthorized access to computer systems is illegal under laws including the Computer Fraud and Abuse Act ([CFAA](https://www.justice.gov/jm/jm-9-48000-computer-fraud)) and similar statutes worldwide. This catalog is not intended to promote or facilitate illegal activity.
127+
128+
Tools are provided for reference only. Use at your own risk and responsibility.
129+
130+
## License
61131

62-
# Drafts and BTS stuff
63-
<img width="986" height="918" alt="Screenshot From 2026-02-15 18-49-04" src="https://github.com/user-attachments/assets/4bc4e7ec-48fd-4c77-8df1-57b5370f2ccd" />
64-
<img width="1908" height="920" alt="image" src="https://github.com/user-attachments/assets/26ef23c7-df20-4d03-be97-2ebb8f85322d" />
65-
<img width="1856" height="1004" alt="image" src="https://github.com/user-attachments/assets/d42cc539-1030-4ae6-bf3d-ccaf449a3a47" />
66-
<img width="1920" height="935" alt="image" src="https://github.com/user-attachments/assets/8ef16d89-6a73-4916-adc4-0e541e98bdb7" />
132+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
67133

134+
---
68135

69-
And yes, I used AI to help a lot with advanced topics. It's pretty obvious, and I am not hiding it because I still learned and applied my knowledge from web security courses and programming classes! And who knew that deploying websites wasn't that hard all this time? not me :D

0 commit comments

Comments
 (0)