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

https://github.com/ephbaum/elxrbb

Trying something, watch out
https://github.com/ephbaum/elxrbb

Last synced: 7 months ago
JSON representation

Trying something, watch out

Awesome Lists containing this project

README

          

# ElxrBB - A Phoenix Forum Application

## About This Project

This is a learning project to build a forum application using Elixir and Phoenix, documented through a comprehensive tutorial. The goal is to create a modern, real-time forum with features like user authentication, threaded discussions, voting, and more.

## Project Restart (October 2025)

This project was restarted with a clean slate to align the codebase with modern Phoenix patterns and the tutorial lessons. The original development work (2023) is preserved in the `archive/initial-attempt` branch.

### Why the Restart?

The original project had several issues:
- Tutorial lessons didn't match the actual implementation
- Outdated Phoenix patterns and syntax
- Missing core forum functionality
- Inconsistent code structure

This fresh start allows us to:
- Follow the tutorial lessons step-by-step
- Use modern Phoenix patterns (LiveView, HEEx, etc.)
- Validate each lesson as we build
- Maintain clean, consistent code

## Current Status

- **Lesson 1**: Environment Setup - Not started
- **Lesson 2**: User Authentication - Not started
- **Lesson 3**: Forum Functionality - Not started
- **Lessons 4+**: Advanced Features - Planned

## Tutorial

Follow along with the complete tutorial at:
https://github.com/ephbaum/elxrBB-tutorial

The tutorial provides step-by-step instructions for building this application from scratch.

## Getting Started

Once we begin implementing the lessons, you'll be able to:

1. Clone this repository
2. Follow the tutorial lessons
3. Build the application step-by-step
4. Learn modern Phoenix development patterns

## Historical Context

The original attempt at this project is preserved in the `archive/initial-attempt` branch. It represents valuable learning about working with AI assistance and the challenges of maintaining tutorial/code alignment.

The original work includes:
- 23 commits showing the development journey
- Pow authentication implementation
- Docker configuration
- Various debugging attempts and lessons learned

## Technology Stack

- **Elixir** - Functional programming language
- **Phoenix** - Web framework for Elixir
- **LiveView** - Real-time, interactive web interfaces
- **PostgreSQL** - Database
- **Tailwind CSS** - Styling
- **Pow** - Authentication library

## License

This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.

## Contributing

This is a learning project, but contributions are welcome! Please see the tutorial repository for the most up-to-date development guidelines.

## Links

- **Application Repository**: https://github.com/ephbaum/elxrBB
- **Tutorial Repository**: https://github.com/ephbaum/elxrBB-tutorial
- **Original Work**: See `archive/initial-attempt` branch