TechLogs π
A modern project sharing platform where developers can showcase their work, discover innovative solutions, and connect with the tech community.
π Features
π― Core Functionality
- Project Showcase: Share your projects with detailed descriptions, live demos, and code repositories
- Community Discovery: Browse and explore projects from developers worldwide
- View Analytics: Track how many people view your projects
- Interactive Dashboard: Manage all your projects from one centralized location
- Real-time Search: Find projects by name, description, or technology stack
π Authentication & User Management
- Secure Authentication: GitHub and Google OAuth integration
- User Profiles: Personalized author pages with project portfolios
- Project Ownership: Edit and delete your own projects with proper authorization
π Rich Content Creation
- Markdown Support: Write detailed project descriptions with full markdown rendering
- Image Upload: Showcase your projects with custom thumbnails
- Live Links: Direct links to demos and repositories
- Category Tagging: Organize projects by technology or type
π¨ Modern UI/UX
- Responsive Design: Perfect experience across all devices
- Dark/Light Mode: Automatic theme switching based on system preferences
- Beautiful Animations: Smooth transitions and hover effects
- Accessibility: Built with accessibility best practices
π οΈ Tech Stack
Frontend
- Next.js 15 - React framework with App Router
- TypeScript - Type safety and better DX
- Tailwind CSS - Utility-first CSS framework
- Lucide React - Beautiful icons
Backend & Database
- Sanity CMS - Headless CMS for content management
- Prisma - Database ORM and schema management
- PostgreSQL - Primary database (via Prisma)
Authentication & Security
- Auth.js (NextAuth) - Authentication solution
- OAuth Providers: GitHub, Google integration
- JWT Tokens - Secure session management
Development Tools
π― Key Features Explained
Project Sharing
Users can create detailed project entries with:
- Rich descriptions using Markdown
- Live demo links and repository links
- Custom thumbnails and category tags
- View tracking to see project popularity
Discovery & Learning
- Browse all projects with search functionality
- Filter by categories (Web Development, Mobile, AI/ML, etc.)
- View author profiles to see their complete portfolio
- Most viewed projects section for trending content
User Dashboard
- Project management - Create, edit, delete projects
- Analytics overview - Track total views across projects
- Profile management - Update user information
- Quick actions - Easy access to create new projects
π Deployment
Vercel (Recommended)
- Push your code to GitHub
- Connect your repository to Vercel
- Add environment variables in Vercel dashboard
- Set build command:
prisma generate && prisma migrate deploy && next build
- Deploy!
Environment Variables for Production
Make sure to set all environment variables in your deployment platform:
- Database connection string
- Authentication secrets and OAuth credentials
- Sanity configuration
- Any additional API keys
π€ Contributing
We welcome contributions! Hereβs how you can help:
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature
- Commit your changes:
git commit -m 'Add amazing feature'
- Push to branch:
git push origin feature/amazing-feature
- Open a Pull Request
Development Guidelines
- Follow the existing code style
- Add TypeScript types for new features
- Test your changes thoroughly
- Update documentation as needed
π License
This project is licensed under the MIT License - see the LICENSE file for details.
π Acknowledgments
- Next.js team for the amazing React framework
- Sanity for the flexible CMS solution
- Auth.js for authentication made simple
- Tailwind CSS for the utility-first CSS framework
- Vercel for seamless deployment experience
π Support
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: contact@saifdev.org