mirror of
https://github.com/altstackHQ/altstack-data.git
synced 2026-04-17 21:53:12 +02:00
feat: rewrite README with real stats, usage examples, and contributor links
This commit is contained in:
AltStack Bot
145
README.md
145
README.md
@@ -1,39 +1,138 @@
|
||||
# The Alt Stack Data & Docs 🥞
|
||||
<p align="center">
|
||||
<img src="https://thealtstack.com/logo.png" alt="The Alt Stack" width="80" />
|
||||
</p>
|
||||
|
||||
Welcome to the public repository for **The Alt Stack** context and data!
|
||||
<h1 align="center">The Alt Stack</h1>
|
||||
|
||||
This repository contains:
|
||||
1. **The Alt Stack Dataset** (`/data`): Our curated JSON data of open source alternatives to popular SaaS products.
|
||||
2. **The Documentation Site** (`/docs`): The source code for [docs.thealtstack.com](https://docs.thealtstack.com) containing 60+ deployment guides, concepts, and more.
|
||||
<p align="center">
|
||||
<strong>The open-source directory of alternatives to every popular SaaS tool.</strong>
|
||||
</p>
|
||||
|
||||
If you are looking for the main application (the UI, comparison engine, etc.), please note that the core application is closed-source. We open-source the data and documentation so the community can contribute to keeping the alternative software ecosystem accurate and well-documented.
|
||||
<p align="center">
|
||||
<a href="https://thealtstack.com">🌐 Website</a> · <a href="https://docs.thealtstack.com">📖 Docs</a> · <a href="https://github.com/altstackHQ/altstack-data/issues/new?template=add-tool.yml">➕ Submit a Tool</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0%20%2B%20CC%20BY%204.0-blue" alt="License" /></a>
|
||||
<img src="https://img.shields.io/badge/tools-459-green" alt="Tools" />
|
||||
<img src="https://img.shields.io/badge/categories-28-orange" alt="Categories" />
|
||||
<img src="https://img.shields.io/badge/deploy%20guides-66-blueviolet" alt="Guides" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## What is The Alt Stack?
|
||||
|
||||
**The Alt Stack** is a curated, community-driven directory that helps developers and teams discover open-source and self-hosted alternatives to popular SaaS products — across **28 categories** including Project Management, Analytics, CRM, AI, DevOps, Communication, and more.
|
||||
|
||||
This repository is the heart of the project. It contains:
|
||||
|
||||
- 🗂️ **The Dataset** — 459+ tools with metadata, pricing, pros/cons, deployment info, and links.
|
||||
- 📖 **66+ Deployment Guides** — Step-by-step self-hosting guides for tools like Plausible, Gitea, Rocket.Chat, and more.
|
||||
- 📚 **Concepts & Docs** — Guides on topics like server setup, monitoring, backups, and secrets management.
|
||||
|
||||
---
|
||||
|
||||
## 📁 Repository Structure
|
||||
|
||||
```
|
||||
altstack-data/
|
||||
├── data/
|
||||
│ ├── tools.json # The core dataset (459+ tools)
|
||||
│ ├── tools-min.json # Minified version
|
||||
│ ├── category_editorial.json # Category descriptions & metadata
|
||||
│ ├── stacks.ts # Curated stack combinations
|
||||
│ ├── seo.ts # SEO metadata
|
||||
│ └── schema/
|
||||
│ └── types.ts # TypeScript schema for the data
|
||||
│
|
||||
├── docs/ # Full documentation site (Nextra)
|
||||
│ └── app/
|
||||
│ ├── deploy/ # 66+ deployment guides
|
||||
│ ├── concepts/ # Self-hosting concepts
|
||||
│ ├── quick-start/ # Getting started guides
|
||||
│ └── stacks/ # Curated stack guides
|
||||
│
|
||||
├── assets/
|
||||
│ └── logos/ # Tool logos
|
||||
│
|
||||
└── .github/
|
||||
├── ISSUE_TEMPLATE/ # Templates for submissions
|
||||
└── workflows/ # CI: JSON validation, docs build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Using the Data
|
||||
|
||||
The dataset is just JSON. Use it however you want.
|
||||
|
||||
**Fetch it directly:**
|
||||
```bash
|
||||
curl -s https://raw.githubusercontent.com/altstackHQ/altstack-data/main/data/tools.json | jq '.[0]'
|
||||
```
|
||||
|
||||
**Use it in JavaScript/TypeScript:**
|
||||
```typescript
|
||||
import tools from './data/tools.json';
|
||||
import type { Tool } from './data/schema/types';
|
||||
|
||||
const analytics = tools.filter(t => t.category === 'Analytics');
|
||||
console.log(`Found ${analytics.length} analytics tools`);
|
||||
```
|
||||
|
||||
**Use it in Python:**
|
||||
```python
|
||||
import json
|
||||
|
||||
with open('data/tools.json') as f:
|
||||
tools = json.load(f)
|
||||
|
||||
open_source = [t for t in tools if t.get('is_open_source')]
|
||||
print(f"{len(open_source)} open source tools available")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
We welcome community contributions! This is the fastest way to get a new tool added or a deployment guide updated.
|
||||
We love contributions! Whether it's adding a tool you discovered, fixing a broken link, or writing a deployment guide — every contribution makes the ecosystem better.
|
||||
|
||||
Before submitting a pull request, please read our [Contributing Guidelines](CONTRIBUTING.md).
|
||||
**Quick links:**
|
||||
- [➕ Add a new tool](https://github.com/altstackHQ/altstack-data/issues/new?template=add-tool.yml)
|
||||
- [🐛 Report a data error](https://github.com/altstackHQ/altstack-data/issues/new?template=fix-data.yml)
|
||||
- [📝 Propose a new guide](https://github.com/altstackHQ/altstack-data/issues/new?template=add-guide.yml)
|
||||
|
||||
### What you can contribute:
|
||||
- **New Tools:** Submit an addition to `data/tools.json`.
|
||||
- **Data Corrections:** Fix broken links, update pricing, or correct pros/cons.
|
||||
- **Deployment Guides:** Write or update a self-hosting guide in `docs/app/deploy/`.
|
||||
- **Typo Fixes:** Help us keep the documentation clean.
|
||||
Read the full **[Contributing Guidelines](CONTRIBUTING.md)** before submitting a PR.
|
||||
|
||||
### What NOT to contribute here:
|
||||
- Feature requests for the main application UI.
|
||||
- Bug reports for the closed-source platform (use the contact form on the main site).
|
||||
---
|
||||
|
||||
## 🗄️ Working with the Data
|
||||
## 📊 Categories
|
||||
|
||||
Our core dataset lives in `data/tools.json` and follows the TypeScript schema defined in `data/schema/types.ts`.
|
||||
| Category | Category | Category | Category |
|
||||
|---|---|---|---|
|
||||
| 💬 Communication | 📊 Analytics | 📋 Project Management | 🤖 AI Interfaces |
|
||||
| 🧠 AI Models | 💻 AI Coding | 🎨 Creative | 📝 CMS |
|
||||
| 📧 Email | ☁️ Cloud Hosting | 🗄️ Databases | 🔐 Security |
|
||||
| 📁 File Storage | 💰 CRM | 🛒 E-commerce | 🎫 Support |
|
||||
| ⚖️ Legal | 🏗️ ERP | 🔄 DevOps | 📺 Media |
|
||||
|
||||
If you're building a project that references our data, you are welcome to consume it directly from this repository!
|
||||
*…and more. Explore the full list at [thealtstack.com](https://thealtstack.com).*
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
|
||||
This repository uses a dual-license model:
|
||||
* **Documentation & Data** (`/docs/**/*.mdx`, `/data/**/*.json`): Creative Commons Attribution 4.0 International ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/))
|
||||
* **Scripts & Code** (`/scripts`, `.ts`/`.js` files): [Apache License 2.0](LICENSE)
|
||||
| What | License |
|
||||
|---|---|
|
||||
| Code & Scripts | [Apache License 2.0](LICENSE) |
|
||||
| Data (`/data`) | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) |
|
||||
| Documentation (`/docs`) | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) |
|
||||
|
||||
*All tool logos in `assets/logos/` are the property of their respective trademark holders and are used for identification purposes only.*
|
||||
All tool logos in `assets/logos/` are the property of their respective trademark holders and are used for identification purposes only.
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>Built with ❤️ by the <a href="https://thealtstack.com/about">Alt Stack team</a></sub>
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user