A comprehensive web-based job board platform that connects job seekers with employers, built with Flask and SQLAlchemy.
FindJob is designed to bridge the gap between qualified job seekers and employers looking for talent. The platform provides intuitive interfaces for posting jobs, searching opportunities, and managing applications with robust security and scalability features.
- User Management: Registration and authentication for job seekers, employers, and admins
- Job Posting: Employers can create and manage job listings
- Job Search: Advanced search and filtering capabilities
- Application Tracking: Seamless application submission and management
- Admin Panel: Comprehensive system management and reporting
- File Uploads: Secure resume and document uploads
- Responsive Design: Mobile-friendly interface
- Real-time Notifications: Email and in-app notifications
- Backend: Flask 3.1.1
- Database: PostgreSQL (Supabase) / SQLAlchemy ORM
- Frontend: Jinja2 Templates, HTML5, CSS3, JavaScript
- Authentication: Flask-JWT, Werkzeug
- Deployment: Render, Gunicorn
- Other: Python-Dotenv, Flask-Session
- Python 3.8+
- PostgreSQL database (or Supabase account)
- Git
-
Clone the repository
git clone https://github.com/Faculty-of-Computing/findjob.git cd findjob -
Create virtual environment
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
-
Install dependencies
pip install -r requirements.txt
-
Environment setup
cp .env.example .env # Edit .env with your database credentials -
Database setup
flask db init flask db migrate flask db upgrade
-
Run the application
flask run
Visit http://localhost:5000 to access the application.
Visit https://findjob-bxs5.onrender.com to access live site.
- Register and create a profile
- Search and apply for jobs
- Track application status
- Upload resume and documents
- Post job openings
- Review and manage applications
- Access employer dashboard
- Manage users and jobs
- View reports and analytics
- System configuration
FindJob is configured for easy deployment on Render with PostgreSQL.
- Push code to GitHub
- Connect repository to Render
- Set environment variables in Render dashboard
- Deploy automatically
See Deployment Guide for detailed instructions.
Comprehensive documentation is available in the docs/ directory:
- Introduction - Project overview and objectives
- System Design - Architecture and technical details
- Functional Requirements - Feature specifications
- API Documentation - API endpoints and usage
- User Manual - User guides and tutorials
- UI/UX Documentation - Interface design
- Implementation Details - Code structure
- Deployment Guide - Production setup
- Risk and Mitigation - Security and risks
- Software Process - Development methodology
- System Documentation - Complete system guide
- Appendix - Additional resources
- Conclusion - Project summary
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
For support and questions:
- Check the documentation
- Open an issue on GitHub
- Contact the development team
- Migrated to PostgreSQL with Supabase for better scalability
- Enhanced environment variable management with .env support
- Updated deployment configuration for production
FindJob - Connecting Talent with Opportunity /home/icekid/Projects/job-board/findjob/README.md