Compete-And-Code
Compete-And-Code is an award-winning web application built with a focus on responsiveness, scalability, and robust functionality. It combines a modern Angular frontend with Bootstrap for responsiveness and AdminLTE for a sleek admin interface. The backend leverages NestJS, powered by TypeORM with SQLite for database operations, and employs JWT authentication for secure user access.
This project secured the First Prize at the Skillathon Coding Competition hosted by City University, establishing itself as a standout solution for those seeking an AdminLTE-based Angular application integrated with a NestJS backend.
Table of Contents
About
Compete-And-Code is a comprehensive platform designed for user authentication, profile management, and administrative tasks. The frontend, powered by Angular and AdminLTE, provides a dynamic and visually appealing interface. The NestJS backend integrates seamlessly with the database, utilizing TypeORM and SQLite, to ensure efficient data handling. Secure JWT-based authentication guarantees user data protection, making this application a robust and scalable foundation for future development.
Features
- Award-Winning Design: Winner of the First Prize at the Skillathon Coding Competition.
- Admin Panel: Fully integrated AdminLTE for a professional and responsive admin dashboard.
- Secure Authentication: Implements JWT-based user authentication for enhanced security.
- User Management: Comprehensive tools for managing user profiles and roles.
- Responsive Design: Built with Bootstrap and AdminLTE for an optimal user experience on all devices.
- Database Integration: Uses TypeORM with SQLite for seamless database operations.
- Scalable Architecture: Modular and extensible, ideal for future customizations and enhancements.
Technologies
Frontend:
- Angular: Framework for building dynamic, single-page applications.
- Bootstrap: Ensures responsive, mobile-first design.
- AdminLTE: Professional admin panel template for enhanced UI/UX.
Backend:
- NestJS: Progressive Node.js framework for building scalable server-side applications.
- TypeORM: Object-Relational Mapping tool for database management.
- JWT Authentication: Secure mechanism for user authentication.
Database:
- SQLite: Lightweight, serverless database solution for quick and efficient development.
Installation
Follow these steps to set up and run the project locally.
Prerequisites:
- Node.js (v18 or higher)
- npm (Node Package Manager)
- SQLite database
Steps:
1. Clone the repository:
git clone https://github.com/devfaisalkhan/compete-and-code.git
2. Navigate to the web directory and install dependencies:
3. Return to the root directory:
4. Navigate to the api directory and install dependencies:
Usage
After completing the installation, you can run the application using the following commands:
1. Start the frontend (web):
2. Start the backend (api):