diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b91cba --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# MegaEngage - Employee Engagement Platform + +## Overview + +MegaEngage is a modern employee engagement platform designed to help organizations measure, track, and improve employee satisfaction and engagement levels. + +## Features + +- **Dashboard**: Real-time analytics and insights +- **Surveys**: Create and manage employee engagement surveys +- **Feedback**: Continuous feedback collection and management +- **Recognition**: Peer-to-peer recognition and rewards +- **Reports**: Comprehensive reporting and data visualization + +## Tech Stack + +- Frontend: React, TypeScript, Tailwind CSS +- Backend: Node.js, Express +- Database: PostgreSQL +- Authentication: JWT + +## Getting Started + +### Prerequisites + +- Node.js (v16 or higher) +- npm or yarn +- PostgreSQL + +### Installation + +1. Clone the repository: +```bash +git clone https://github.com/PetrAnto/megaengage.git +cd megaengage +``` + +2. Install dependencies: +```bash +npm install +``` + +3. Set up environment variables: +```bash +cp .env.example .env +``` +Edit `.env` with your configuration. + +4. Start the development server: +```bash +npm run dev +``` + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Contact + +For questions or feedback, please open an issue in this repository.