diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 73 |
1 files changed, 70 insertions, 3 deletions
@@ -4,19 +4,86 @@ <img alt="FreeFlow Logo" src="https://github.com/xAlpharax/FreeFlow/blob/master/assets/FreeFlowLogo.png" height="200px"> </picture> <br> -Learning made easy +Enhancing Learning Resources for University Students </div> -<br> # FreeFlow My team's Code and Notes throughout the BEST Brasov Hackathon competition @ https://hackathon.bestbrasov.ro/ +FreeFlow: Enhancing Learning Resources for University Students +FreeFlow - Learn free in a different flow. +Learning made easy + # Description / Proposition +FreeFlow is a comprehensive e-learning platform designed to enhance the learning experience for university students. Built on a powerful combination of Node.js and React, FreeFlow adopts the xAPI and LTI paradigms, providing a seamless and intuitive interface for both students and educators. This platform aims to offer a rich learning environment, making it easier for students to access relevant resources and for educators to deliver content in a structured manner. + +## Features + +xAPI Integration: FreeFlow utilizes the xAPI (Experience API) to track and analyze student interactions with learning resources, enabling a personalized and adaptive learning experience. + +LTI Support: Leveraging the Learning Tools Interoperability standard, FreeFlow seamlessly integrates with various educational tools, creating a unified learning ecosystem. + +Node.js Backend: The backend is powered by Node.js, ensuring scalability, efficiency, and a robust server infrastructure. + +React Frontend: The frontend is built with React, providing a responsive and dynamic user interface for an optimal user experience. + +Resource Recommendation: FreeFlow employs intelligent algorithms to recommend learning resources based on user behavior, preferences, and academic progress. + # Documentation ## Requirements -## Usage +Node.js (version X.X.X) +npm (version X.X.X) +SQL/MongoDB (version X.X.X) +react ?? +stuff + +## Installation & Usage + +Clone the repository: + +```bash +git clone git@github.com:xAlpharax/FreeFlow.git +``` + +Navigate to the project directory: + +```bash +cd FreeFlow +``` + +Install dependencies: + +```bash +npm install +``` + +Configure environment variables: + +Create a .env file in the root directory. +- Define the required environment variables. +- Refer to .env.example for guidance. + +Start the application: + +```bash +npm start +``` + +Visit http://localhost:3000 in your browser. ## Contribuiting + +We welcome contributions from the community! To contribute to FreeFlow, follow these steps: + +Fork the repository. +Create a new branch for your feature or bug fix. +Make your changes and commit them with descriptive messages. +Push your changes to your fork. +Submit a pull request. + +## License + +FreeFlow is software released under the GNU Affero General Public License (AGPL). |