A full-stack web application combining a personal developer portfolio with a GitHub repository explorer.
Discover public repositories and developers, save your favourite projects, follow developers and connect your GitHub account — all in one place.
Documentation • GitHub Repository • Developer
Features • Technology Stack • Latest Release • Getting Started • Running the Application • Deployment • Project Structure • Documentation • Roadmap
Important
Clonvix is currently in active development. Features, functionality and the overall application are subject to change as development continues.
- Full-stack application built with Django REST Framework and React, deployed on Render.
- Responsive interface with light, dark and system theme options.
- GitHub repository, user and topic search using the GitHub REST API.
- Repository search with language filtering, sorting and pagination.
- Dedicated topic landing and detail pages for discovering repositories.
- GitHub user and organisation profile pages displaying profile information, social links and statistics.
- Profile pages with repository listings, README previews, and Followers and Following views for users, including organisation follower support.
- Repository detail pages displaying metadata, README content, latest release information, deployments, contributors, language statistics and repository files.
- Trending repositories ranked by historical star growth, with daily, weekly and monthly views.
- Backend integration with server-side caching to reduce GitHub API requests.
- PostgreSQL-backed daily repository star snapshots.
- Automated GitHub Actions workflows for backend testing and frontend quality checks.
- User registration, login and account management.
- Save repositories independently of GitHub stars.
- Follow Clonvix users and GitHub developers.
- GitHub account connection and OAuth login.
- Profile customisation and additional account features.
- Further accessibility, testing and responsive improvements.
| Area | Technologies |
|---|---|
| Frontend | React, TypeScript, Vite, React Router, Tailwind CSS v4 |
| Backend | Python, Django, Django REST Framework |
| Database | PostgreSQL, Neon |
| Caching | Redis, Upstash |
| External services | GitHub REST API, Cloudinary, Brevo |
| Deployment | Render, gunicorn, WhiteNoise |
| CI/CD | GitHub Actions |
| Development | Git, GitHub, Layerbase |
v0.7.0 — GitHub Developer Profiles
Introduces GitHub user and organisation profiles, including repository exploration, README previews, and follower/following views.
See the full release notes for details.
Install the following before starting development:
- Python 3.14 or later
- Node.js and npm
- PostgreSQL, or access to a PostgreSQL database such as Neon
- Redis, or access to a Redis instance
- Git
git clone https://github.com/ColmN-Dev/Clonvix.git
cd ClonvixFrom the repository root:
cd src/backend
python -m venv .venvActivate the virtual environment:
# Windows PowerShell
.venv\Scripts\Activate.ps1
# macOS/Linux
source .venv/bin/activateInstall the Python dependencies:
python -m pip install -r requirements.txtCreate a .env file in the project root with the values needed for local development:
DEBUG=True
SECRET_KEY=replace-with-a-local-development-key
DATABASE_URL=postgresql://username:password@localhost:5432/database_name
REDIS_URL=replace-with-your-redis-connection-url
CLOUDINARY_URL=cloudinary://api_key:api_secret@cloud_name
GITHUB_API_TOKEN=replace-with-a-github-personal-access-token
BREVO_API_KEY=replace-with-your-brevo-api-keyThe database URL can be replaced with a Neon connection string when using a hosted PostgreSQL database. Set DB_SSL=True if the host requires SSL and the connection string does not already include it.
REDIS_URL should point to your Redis instance. Clonvix uses Redis as Django's cache backend for GitHub API responses, including repository, user and topic search results, user profiles, repository READMEs, follower/following data, and Trending results.
GITHUB_API_TOKEN is a GitHub personal access token used to authenticate API requests. Read-only access to public repository data is sufficient. Without a token, GitHub applies lower API rate limits.
Apply the database migrations:
python manage.py migrateFrom the repository root:
cd src/frontend
npm installFrom the repository root, run the appropriate script for your environment:
Windows PowerShell:
.\dev.ps1macOS/Linux or Windows Git Bash:
./dev.shBoth scripts automatically activate the Python virtual environment, clean up repository snapshots older than 30 days, collect the latest snapshots, and start both development servers.
The backend will be available at http://127.0.0.1:8000/. A quick check that it is running is http://127.0.0.1:8000/api/status/.
The frontend will be available at the local URL shown by Vite, normally http://localhost:5173/.
Press Ctrl + C to stop both development servers.
Clonvix runs as a single Render web service. Django serves the built React app, so the frontend and backend share one origin.
- Build command:
bash build.sh - Start command:
cd src/backend && gunicorn config.wsgi:application
build.sh builds the React app, installs the Python dependencies, collects the static files and runs the database migrations. WhiteNoise serves the built frontend files from /static/, and a catch-all route in config/urls.py returns index.html so React Router pages work on refresh.
Environment variables set on Render:
| Variable | Purpose |
|---|---|
SECRET_KEY |
Django secret key for production |
DATABASE_URL |
Neon PostgreSQL connection string |
DEBUG |
Set to False in production |
GITHUB_API_TOKEN |
Production GitHub token with read-only public access |
REDIS_URL |
Upstash Redis connection string |
CLOUDINARY_URL |
Cloudinary connection details |
BREVO_API_KEY |
Brevo API authentication key |
Clonvix/
├── .github/
│ └── workflows/ # GitHub Actions workflows
├── build.sh # Render build script
├── dev.sh # Development startup script (Linux/macOS)
├── dev.ps1 # Development startup script (Windows)
├── docs/ # Project planning, design and supporting documentation
├── src/
│ ├── backend/ # Django project and API
│ │ ├── accounts/ # Custom user model and accounts application
│ │ ├── config/ # Django settings and URL configuration
│ │ └── github/ # GitHub API features
│ └── frontend/ # React, TypeScript and Vite application
│ ├── public/ # Public assets and static files
│ └── src/
│ ├── assets/ # Application images and imported assets
│ ├── components/ # Reusable UI components
│ ├── pages/ # Application pages and views
│ ├── types/ # TypeScript interfaces and type definitions
│ └── utils/ # Shared utility functions and helpers
└── README.md
The structure will grow as the planned features are implemented. The more detailed current tree is maintained in Project documentation.
Additional project documentation is available in the docs directory.
- Technical Documentation
- Project Plan
- Database Entity Relationship Diagram
- Presentations
- Wireframes
- Project diagrams and images
- Add user registration, login and account management.
- Implement saved repositories and developer-following features.
- Integrate GitHub account connection and OAuth login.
- Expand profile customisation and portfolio features.
- Integrate remaining external services.
- Improve testing, accessibility, responsiveness and production readiness.



