AcadAI 📚✨

Welcome to AcadAI, a smart academic productivity app designed to help students manage deadlines, study schedules, and academic resources. Built with Next.js, AcadAI integrates various tools to streamline your academic journey.

Table of Contents

• Features
• Technologies Used
• Installation
• Usage
• Contributing
• License
• Contact
• Releases

Features 🌟

• Deadline Management: Keep track of all your important deadlines in one place.
• Study Schedules: Create and manage your study schedules easily.
• Resource Management: Access academic resources directly from the app.
• Integration with Tools: Seamlessly integrates with Google Drive, Notion, and Dropbox.
• AI Assistance: Leverage OpenAI's capabilities for personalized study tips and resources.
• Responsive Design: Works on all devices, ensuring you can access your information anytime, anywhere.

Technologies Used 🛠️

AcadAI is built using a combination of modern technologies to provide a robust and efficient user experience. The main technologies include:

• Next.js: A React framework for server-side rendering.
• Node.js: For backend development.
• TypeScript: Enhances JavaScript with static types.
• Tailwind CSS: For styling the application.
• Firebase: For real-time database and authentication.
• Google OCR: To convert images to text.
• Notion API: For integrating with Notion.
• Dropbox: For file storage.
• OpenAI: For AI-powered features.

Installation 🚀

To get started with AcadAI, follow these steps:

1. Clone the Repository:

   git clone https://github.com/flausseur/acadai.git
   cd acadai
   

2. Install Dependencies:

   npm install
   

3. Set Up Environment Variables: Create a .env.local file in the root directory and add your configuration settings. Refer to the .env.example file for guidance.

4. Run the Development Server:

   npm run dev
   

Your application should now be running at http://localhost:3000.

Usage 📅

Once you have the application running, you can start using its features:

• Manage Deadlines: Add, edit, or delete deadlines from the dashboard.
• Create Study Schedules: Use the calendar feature to plan your study sessions.
• Access Resources: Navigate to the resources section to find useful academic materials.
• AI Assistance: Ask for study tips or resource recommendations using the AI feature.

Contributing 🤝

We welcome contributions to AcadAI! If you would like to contribute, please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of the page.
2. Create a New Branch:

   git checkout -b feature/YourFeatureName
   

3. Make Your Changes: Implement your feature or fix.
4. Commit Your Changes:

   git commit -m "Add your message here"
   

5. Push to Your Branch:

   git push origin feature/YourFeatureName
   

6. Create a Pull Request: Go to the original repository and click on "New Pull Request."

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.

Contact 📬

For any inquiries, please reach out to:

• Email: your-email@example.com
• GitHub: flausseur

Releases 📦

For the latest releases, visit our Releases section. You can download and execute the latest version of AcadAI from there.

Conclusion

Thank you for checking out AcadAI! We hope this application helps you enhance your academic productivity. If you have any questions or feedback, feel free to reach out. Happy studying!