AppFlowy is an open-source no-code platform for your wikis, notes, tasks, and more, available for Windows, macOS, and Linux. You are in charge of your data and customizations.
Since its GitHub launch in November 2021, it has accumulated more than 30,000 stars and 130+ contributors. In 2022, AppFlowy was selected for the Noteworthy Newcomer award as part of the Open Source Awards at GitHub Universe!
AppFlowy is built with Flutter and Rust, an interesting tech stack with a lot of potential and opportunities. If you are a true believer in open source and want to build a world-class open source collaboration software together, we’d love to hear from you!
An Octernship with AppFlowy is aimed at creating a hands-on learning opportunity for new developers who may otherwise lack the opportunity to gain exposure to real-world software practice and entry to the technical community.
Benefits for Students:
- Students gain exposure to real-world software development and entry to the open-source community.
- Students become more competitive in the job market by having more meaningful software development experience.
- Students have hands-on opportunities to do work related to their professional interests and to further the pursuit of their interests.
- Students expand their professional network by getting involved in the community and meeting other awesome contributors.
Program Structure:
You will develop both hard and soft skills required for a software engineer in the real world throughout the program.
The program will provide you with the opportunity to:
- Collect and discuss business requirements cross-functionally
- Conduct a tech review to have your mentor and peers review your tech design doc
- Give and receive code reviews to/from your peers
- Offer help to the community
- Know your mentor and peers and participate in online hangouts
- Write an article related to your project and get it published to our newsletter - AppFlowy Binary
Check out projects our mentees are working on
- The GitHub Classroom assignment submission date should be specified in your project proposal.
- Length of the Octernship: 6 weeks or 12 weeks depended on your project scope
- Monthly Stipend: 600 USD
Becoming an AppFlowy contributor is a prerequisite. Newcomers are encouraged to complete an issue tagged with the “good first issue for devs”. This requires you to get familiar with our codebase and demonstrates your interest in contributing to AppFlowy. Don’t worry if you make mistakes in your first contribution. Instead, please see it as a great opportunity to get involved in our community, receive feedback, and iterate your work - a flavor of doing a project with the community.
To participate, you must be:
-
A verified student on Global Campus
-
18 years or older
-
Active contributor on GitHub (monthly)
-
Please select an unclaimed task under the Desktop Features section from Project Ideas and then submit a project proposal when applying via GitHUb Octernship
Please select an unclaimed task under the Desktop Features section from Project Ideas
Work with your assigned mentor to publish your project doc to AppFlowy Documentation
Your project doc should include:
- The problem
- The solution
- Goals
- Implementation design
- Timeline
- Risks & Mitigation
More details can be found here
- Deliver your solution outlined in your project doc
Students are expected to use the GitHub Flow when working on their project.
-
Using GitHub Classroom to make submissions
-
Opening a Pull Request for review
-
Using GitHub Discussions to ask any relevant questions regarding the project
This project is a starting point for a AppFlowy editor plugin sample.
# Please make sure the version of your flutter is 3.3.10
flutter pub get
flutter run- horizontal_rule_widget_builder is for reference to how to create a plugin.
- horizontal_rule_menu_items is for reference to how to add a new menu item to selection menu(slash menu).
- horizontal_rule_shortcut_event is for reference to how to add a new shortcut to insert a horizontal rule.