An open API service indexing awesome lists of open source software.

https://github.com/psypherion/datafolio

A lightweight, JSON-driven portfolio builder for developers, designers, and professionals who want complete control over their portfolio data with schema validation and easy deployment.
https://github.com/psypherion/datafolio

developer-tools docker fastapi json-schema open-source portfolio-builder portfolio-management portfolio-website python rest-api web-dashboard

Last synced: 2 months ago
JSON representation

A lightweight, JSON-driven portfolio builder for developers, designers, and professionals who want complete control over their portfolio data with schema validation and easy deployment.

Awesome Lists containing this project

README

          

# dataFolio

A comprehensive, JSON-driven platform for creating and managing professional portfolio websites. Built for developers, designers, academics, and professionals who want complete control over their portfolio data with validation and portability.

## ✨ Features

- **🔧 JSON Schema-driven validation** - Robust data integrity with comprehensive error checking
- **🎨 Intuitive web dashboard** - User-friendly interface for portfolio management
- **🚀 RESTful API** - Full programmatic control and third-party integrations
- **📁 Modular data model** - Personal info, projects, academics, blog, and settings
- **🎬 Rich media support** - Videos, image galleries, diagrams, and interactive content
- **📤 Import/Export functionality** - Easy data sharing, backup, and migration
- **🔒 licensing** - Free for personal use
- **🌐 Open source** - Transparent, extensible, and community-driven

## 🚀 Quick Start

### Clone the repository

```
git clone https://github.com/yourusername/dataFolio.git
cd dataFolio
```

### Set up Python environment

```
python -m venv venv
source venv/bin/activate

# On Windows: venv\Scripts\activate

```

### Install dependencies

```
pip install -r requirements.txt

```

### Start the development server

```
uvicorn app/main:app --reload --host 0.0.0.0 --port 8000

```

Open your browser to [http://localhost:8000](http://localhost:8000) to access the dashboard.

## 📚 Documentation

Complete documentation is available in the [`/docs`](./docs) directory:

- **[Getting Started](./docs/getting-started.md)** - Installation and first portfolio
- **[User Guide](./docs/user-guide.md)** - Dashboard usage and features
- **[API Reference](./docs/api-reference.md)** - Complete API documentation
- **[Schema Reference](./docs/schema-reference.md)** - JSON schema and validation rules

## 🎯 Why Choose This System?

### For Individuals
- **Complete data ownership** - Your portfolio data in portable JSON format
- **Professional presentation** - Schema-driven structure ensures consistency
- **Easy maintenance** - Update once, reflect everywhere
- **Future-proof** - JSON-based data survives platform changes

### For Developers
- **API-first design** - Build custom integrations and automations
- **Extensible architecture** - Add new fields and features easily
- **Open source** - Full transparency and community contributions
- **Enterprise ready** - Commercial licensing and professional support available

## 🤝 Contributing

We welcome contributions from the community! Here's how you can help:

1. **🐛 Report bugs** - Open an issue with detailed reproduction steps
2. **💡 Suggest features** - Share your ideas via GitHub Discussions
3. **🔧 Submit code** - Fork, create a feature branch, and submit a PR
4. **📝 Improve docs** - Help make our documentation clearer and more comprehensive

Please read our [Contributing Guidelines](./docs/contributing.md) before getting started.

## 📄 License

This project uses dual licensing to balance open source community benefits with sustainable development:

### Open Source License
**GNU Affero General Public License v3.0 (AGPL-3.0)**
- ✅ Free for personal portfolios
- ✅ Free for educational use
- ✅ Free for open source projects
- ✅ Community support via GitHub

## 🆘 Support

### Community Support
- **[GitHub Issues](../../issues)** - Bug reports and feature requests
- **[GitHub Discussions](../)** - Community Q&A and ideas
- **[Documentation](./docs)** - Comprehensive guides and references

## ⭐ Show Your Support

If this project helps you build an amazing portfolio, please consider:

- ⭐ **Starring this repository**
- 🐦 **Sharing on social media**
- 💝 **Contributing to the project**

---

**Made with ❤️ by psypherion**

*Building the future of portfolio management, one JSON schema at a time.*

---

© 2025 Portfolio Builder System. licensed under AGPL-3.0.