diff --git a/.gitbook/assets/achromatic-black.zip b/.gitbook/assets/achromatic-black.zip new file mode 100644 index 0000000..1050935 Binary files /dev/null and b/.gitbook/assets/achromatic-black.zip differ diff --git a/.gitbook/assets/achromatic-white.zip b/.gitbook/assets/achromatic-white.zip new file mode 100644 index 0000000..91495a1 Binary files /dev/null and b/.gitbook/assets/achromatic-white.zip differ diff --git a/.gitbook/assets/artboard-1-copy-2.jpg b/.gitbook/assets/artboard-1-copy-2.jpg new file mode 100644 index 0000000..3c2f10e Binary files /dev/null and b/.gitbook/assets/artboard-1-copy-2.jpg differ diff --git a/.gitbook/assets/artboard-1-copy-3.jpg b/.gitbook/assets/artboard-1-copy-3.jpg new file mode 100644 index 0000000..bc66ad0 Binary files /dev/null and b/.gitbook/assets/artboard-1-copy-3.jpg differ diff --git a/.gitbook/assets/artboard-1-copy-4.jpg b/.gitbook/assets/artboard-1-copy-4.jpg new file mode 100644 index 0000000..a877425 Binary files /dev/null and b/.gitbook/assets/artboard-1-copy-4.jpg differ diff --git a/.gitbook/assets/artboard-2 (1).jpg b/.gitbook/assets/artboard-2 (1).jpg new file mode 100644 index 0000000..8350910 Binary files /dev/null and b/.gitbook/assets/artboard-2 (1).jpg differ diff --git a/.gitbook/assets/artboard-2.jpg b/.gitbook/assets/artboard-2.jpg new file mode 100644 index 0000000..8350910 Binary files /dev/null and b/.gitbook/assets/artboard-2.jpg differ diff --git a/.gitbook/assets/artboard-3.jpg b/.gitbook/assets/artboard-3.jpg new file mode 100644 index 0000000..08cfe61 Binary files /dev/null and b/.gitbook/assets/artboard-3.jpg differ diff --git a/.gitbook/assets/artboard-4.jpg b/.gitbook/assets/artboard-4.jpg new file mode 100644 index 0000000..8e24e30 Binary files /dev/null and b/.gitbook/assets/artboard-4.jpg differ diff --git a/.gitbook/assets/ayush (1).jpg b/.gitbook/assets/ayush (1).jpg new file mode 100644 index 0000000..6efa9b2 Binary files /dev/null and b/.gitbook/assets/ayush (1).jpg differ diff --git a/.gitbook/assets/ayush.jpg b/.gitbook/assets/ayush.jpg new file mode 100644 index 0000000..6efa9b2 Binary files /dev/null and b/.gitbook/assets/ayush.jpg differ diff --git a/.gitbook/assets/brandmark.jpg b/.gitbook/assets/brandmark.jpg new file mode 100644 index 0000000..2a19dda Binary files /dev/null and b/.gitbook/assets/brandmark.jpg differ diff --git a/.gitbook/assets/colored-horizontal.png b/.gitbook/assets/colored-horizontal.png new file mode 100644 index 0000000..b455f05 Binary files /dev/null and b/.gitbook/assets/colored-horizontal.png differ diff --git a/.gitbook/assets/colored-horizontal.svg b/.gitbook/assets/colored-horizontal.svg new file mode 100644 index 0000000..b20f365 --- /dev/null +++ b/.gitbook/assets/colored-horizontal.svg @@ -0,0 +1 @@ +Colored-Horizontal \ No newline at end of file diff --git a/.gitbook/assets/colored-logomark.png b/.gitbook/assets/colored-logomark.png new file mode 100644 index 0000000..b729c1a Binary files /dev/null and b/.gitbook/assets/colored-logomark.png differ diff --git a/.gitbook/assets/colored-logomark.svg b/.gitbook/assets/colored-logomark.svg new file mode 100644 index 0000000..4b1ec29 --- /dev/null +++ b/.gitbook/assets/colored-logomark.svg @@ -0,0 +1 @@ +Colored-LogoMark \ No newline at end of file diff --git a/.gitbook/assets/colored-vertical.png b/.gitbook/assets/colored-vertical.png new file mode 100644 index 0000000..a6c4c23 Binary files /dev/null and b/.gitbook/assets/colored-vertical.png differ diff --git a/.gitbook/assets/colored-vertical.svg b/.gitbook/assets/colored-vertical.svg new file mode 100644 index 0000000..5762b5e --- /dev/null +++ b/.gitbook/assets/colored-vertical.svg @@ -0,0 +1 @@ +Colored-Vertical \ No newline at end of file diff --git a/.gitbook/assets/designthinking.png b/.gitbook/assets/designthinking.png new file mode 100644 index 0000000..db74125 Binary files /dev/null and b/.gitbook/assets/designthinking.png differ diff --git a/.gitbook/assets/devansh.jpg b/.gitbook/assets/devansh.jpg new file mode 100644 index 0000000..95b0261 Binary files /dev/null and b/.gitbook/assets/devansh.jpg differ diff --git a/.gitbook/assets/donut-documentation.pdf b/.gitbook/assets/donut-documentation.pdf new file mode 100644 index 0000000..82398f2 Binary files /dev/null and b/.gitbook/assets/donut-documentation.pdf differ diff --git a/.gitbook/assets/font.jpg b/.gitbook/assets/font.jpg new file mode 100644 index 0000000..9f782b1 Binary files /dev/null and b/.gitbook/assets/font.jpg differ diff --git a/.gitbook/assets/presentation-logo-horizontal.jpg b/.gitbook/assets/presentation-logo-horizontal.jpg new file mode 100644 index 0000000..33e9a35 Binary files /dev/null and b/.gitbook/assets/presentation-logo-horizontal.jpg differ diff --git a/.gitbook/assets/presentation-logo-logomark.jpg b/.gitbook/assets/presentation-logo-logomark.jpg new file mode 100644 index 0000000..341a40b Binary files /dev/null and b/.gitbook/assets/presentation-logo-logomark.jpg differ diff --git a/.gitbook/assets/presentation-logo-vertical.jpg b/.gitbook/assets/presentation-logo-vertical.jpg new file mode 100644 index 0000000..ce9f246 Binary files /dev/null and b/.gitbook/assets/presentation-logo-vertical.jpg differ diff --git a/.gitbook/assets/primary-brandmark.jpg b/.gitbook/assets/primary-brandmark.jpg new file mode 100644 index 0000000..dff4243 Binary files /dev/null and b/.gitbook/assets/primary-brandmark.jpg differ diff --git a/README.md b/README.md index 600d7e8..ec31f09 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,25 @@ description: >- # About CodeUino -### **CodeUino** - ![](.gitbook/assets/assets_-lsv46f7uzuvdedvews0_-ltflz2mqkow25nhe1al_-ltfx2lgurmnrrocpgfm_artboard-2-copy.jpg) -### **What is CodeUino?** - -CodeUino is a Non-Profit Open Source Social Networking organisation that provides various robust frameworks solutions which could span the entire world through building all kinds of social environments, discussion portals and collaboration platforms by giving prospectus to various other organisations, users and outreachers to showcase their products in a custom way. - -This wide social open networking framework organisation is driven by the volunteers all over the globe. This helps open source enthusiast to build up various technocratic social wide living softwares and researching FOSS projects under code survivors and challenging world. CodeUino takes into house the development of some of the coolest Open Source Projects that are made with the sole motive to benefit more and more people present all over the world. +## **What is Codeuino?** +Codeuino is an open source social networking organisation that provides various robust frameworks solutions which could span the entire world through building all kinds of social environments, discussion portals and collaboration platforms by giving prospectus to various other organisations, users and outreachers to showcase their products in a custom way. +This wide social open networking framework organisation is driven by the volunteers all over the globe. This helps open source enthusiast to build up various technocratic social wide living softwares and researching FOSS projects under code survivors and challenging world. Codeuino takes into house the development of some of the coolest Open Source Projects that are made with the sole motive to benefit more and more people present all over the world. -### **Who are we?** +## **Who are we?** We are a group of young open source contributors creatively leveraging our expertise in Social networking and development projects to improve the quality of outreaching, interaction and collaboration for the people in developing nations. We consists of various teams from Development, Documentation, Designers and Donut Platform. Everyone at CodeUino contributes to increase efficiency, outreaching for the user and expedite idea generation for social networking. +## Mission +Communications technology has enabled new approaches to communities and end-users in which stakeholders across sectors and organizations are engaged in consensus building and implementation processes for open source ecosystem. So Codeuino works with a vision to have open sustainability within social networking and build OSS/FOSS social-environmental tools with a sole motive to benefit organizations and individuals to have a common platform for collaboration. -### **What do we do?** +## **What do we do?** -* CodeUino takes into house the development of some of the coolest Open Source Projects that are made with the sole motive to benefit more and more people present all over the world. **** +* CodeUino takes into house the development of some of the coolest Open Source Projects that are made with the sole motive to benefit more and more people present all over the world. * Teams within organization design and develop some basic set of softwares and networking plugins to help users/organisations to build up their own platform to interact for feeds, projects, Scholarships, etc. -* We build social networking Kit/FOSS for various organisations to build up social environment for their organisation to showcase their productivity and services for their community along with the collaboration platform to interact with one another. +* We build social networking Kit-FOSS for various organisations to build up social environment for their organisation to showcase their productivity and services for their community along with the collaboration platform to interact with one another. diff --git a/SUMMARY.md b/SUMMARY.md index 36ea198..921d5d5 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,25 +1,72 @@ # Table of contents * [About CodeUino](README.md) -* [CodeUino Docs](codeuino-docs.md) - -## Donut - -* [Donut Documentation](donut-docs/donut-documentation/README.md) - * [Donut Frontend](donut-docs/donut-documentation/donut-frontend.md) - * [Donut Backend](donut-docs/donut-documentation/donut-backend/README.md) - * [About](donut-docs/donut-documentation/donut-backend/about.md) - * [Installation](donut-docs/donut-documentation/donut-backend/installation.md) - * [Client-Side](donut-docs/donut-documentation/donut-backend/client-side.md) - * [Server Side](donut-docs/donut-documentation/donut-backend/server-side.md) - * [Contributors Guide](donut-docs/donut-documentation/donut-backend/contributors-guide.md) - * [Donut Design Guidelines](donut-docs/donut-documentation/donut-design-guidelines/README.md) - * [Design Workflow](donut-docs/donut-documentation/donut-design-guidelines/design-workflow.md) - * [Contribute to Design](donut-docs/donut-documentation/donut-design-guidelines/contribute-to-design.md) - -## Codebadge - -* [Codebadge Documentation](codebadge/codebadge-documentation/README.md) - * [Codebadge Frontend](codebadge/codebadge-documentation/codebadge-frontend.md) - * [Codebadge Backend](codebadge/codebadge-documentation/codebadge-backend.md) +* [Our Values](our-values.md) +* [Community Guidelines](community-guidelines.md) +* [Role and Responsibilities](role-and-responsibilities.md) +* [Path to Leadership](path-to-leadership.md) +* [Codeuino Projects](codeuino-docs.md) +* [CodeUino Design](design-guidelines/README.md) + * [Design Workflow](design-guidelines/design-workflow.md) + * [Contributing to Design](design-guidelines/contributing-to-design.md) + * [Product Research Workflow](design-guidelines/product-research-workflow.md) + * [Contributing to Product Research](design-guidelines/contributing-to-product-research.md) + * [Codeuino Visual Identity](design-guidelines/visual-identity.md) +* [Meetings Notes](meetings-notes.md) + +## Projects + +* [Donut - Social Networking Platform](https://docs.codeuino.org/donut-social-networking-platform/) +* [Donut - Social Platform](projects/social-platform-donut/README.md) + * [Ideas](projects/social-platform-donut/ideas.md) + * [About Donut](projects/social-platform-donut/about-donut.md) + * [Donut Design Guidelines](projects/social-platform-donut/donut-design-guidelines/README.md) + * [Brand Visual Guide](projects/social-platform-donut/donut-design-guidelines/brand-visual-guide.md) + * [Donut Frontend](projects/social-platform-donut/donut-frontend.md) + * [Donut Backend](projects/social-platform-donut/donut-backend/README.md) + * [About](projects/social-platform-donut/donut-backend/about.md) + * [Installation](projects/social-platform-donut/donut-backend/installation.md) + * [Client-Side](projects/social-platform-donut/donut-backend/client-side.md) + * [Server Side](projects/social-platform-donut/donut-backend/server-side.md) + * [Contributors Guide](projects/social-platform-donut/donut-backend/contributors-guide.md) + * [Donut Database Schema](projects/social-platform-donut/donut-database-schema.md) +* [Codebadge](projects/codebadge/README.md) + * [About Codebadege](projects/codebadge/about-codebadege.md) + * [Codebadge Frontend](projects/codebadge/codebadge-frontend.md) + * [Codebadge Backend](projects/codebadge/codebadge-backend.md) + +## Internship + +* [Codeuiners](internship/codeuiners/README.md) + * [Ayush Nagar](internship/codeuiners/ayush-nagar.md) + * [Devansh Agrawal](internship/codeuiners/devansh-agrawal.md) + +## ACTIVITIES + +* [Google-Summer-Of-Code-2021](activities/google-summer-of-code-2021/README.md) + * [GSoC 2021 Idea Page](activities/google-summer-of-code-2021/gsoc-2021-idea-page.md) +* [Google-Summer-Of-Code-2020](activities/gsoc2020/README.md) + * [GSoC 2020 Idea Page](activities/gsoc2020/gsoc2020-ideas/README.md) + * [Development of Admin Management mechanism for DONUT](activities/gsoc2020/gsoc2020-ideas/role-management.md) + * [Developing a module with a Tag Cloud and a post check mechanism](activities/gsoc2020/gsoc2020-ideas/tag-mechanism.md) + * [Displaying Github Activity Data in Donut Platform](activities/gsoc2020/gsoc2020-ideas/github-bot.md) + * [Proposal Functionality\(Pledge a research project\) inside Donut](activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md) + * [Personal Assistant for Donut Platform](activities/gsoc2020/gsoc2020-ideas/draft-bot-for-donut-platform.md) + * [Badge and point allotment API inside Codebadge](activities/gsoc2020/gsoc2020-ideas/badge-and-point-allotment-api.md) + * [Issues, Pull request and Comment Management API inside Codebadge](activities/gsoc2020/gsoc2020-ideas/issue-management-api.md) + * [Virtual Illustration in Codebadge](activities/gsoc2020/gsoc2020-ideas/virtual-illustration-in-codebadge.md) +* [Google-Summer-Of-Code-2019](activities/google-summer-of-code-2019/README.md) + * [GSOC-2019-Ideas](activities/google-summer-of-code-2019/gsoc-2019-ideas.md) +* [GSOC Student-Application-Template](activities/gsoc-student-application-template.md) +* [Google Season of Docs 2020](activities/google-season-of-docs-2020.md) +* [Rails Girls Summer of Code 2020](activities/rails-girls-summer-of-code-2020.md) +* [Linux Foundation CommunityBridge Mentorship Program - Codeuino Mentorship](activities/linux-foundation-communitybridge-mentorship-program-codeuino-mentorship.md) + +--- + +* [Development](development/README.md) + * [Contribution Worklfow](development/contribution-worklfow.md) +* [Documentation](documentation/README.md) + * [Working with Changes](documentation/working-with-changes.md) +* [Outreach](outreach.md) diff --git a/activities/google-season-of-docs-2020.md b/activities/google-season-of-docs-2020.md new file mode 100644 index 0000000..485588b --- /dev/null +++ b/activities/google-season-of-docs-2020.md @@ -0,0 +1,218 @@ +# Google Season of Docs 2020 + +## Welcome to Google Season of Docs with Codeuino + +[**Google Season of Docs**](https://developers.google.com/season-of-docs/) is a global program which encourages technical writers to gain an exposure to documentations of real-world open source project scenarios either by building a new documentation set, or redesigning the existing docs, or improving and documenting the open source community's contribution procedures and on-boarding experience to transmute their technical skills to greater levels + +Google awards stipends, to all successful technical writer who complete their documentation of open-source projects under [**Codeuino**](http://www.codeuino.org/). Alongside Codeuino community members volunteer as "mentors" to aspirants, who assist them about their summer documentation projects and succeed their projects in an expected way. + +To learn more about this year's event and how GSoD works, please refer to the [**Frequently Asked Question \(FAQ\)**](https://developers.google.com/season-of-docs/docs/faq). + +**We are applying to Google Seasons of Docs, accepted organizations will be announced on May 11,2020. We already have many project ideas posted below, and we welcome potential participants and mentors to reach out to us.** + +## **Get in Touch with us** + +The Organisation administrators for **GSoD** **2020** are [**Devesh Verma**](https://github.com/devesh-verma) followed by co-organisation administrator + +* **Org Admin contact:** Devesh Verma and + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **SLACK Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org) +* **Contact Email:** gsod@codeuino.org + +## **Involving as a Student under Codeuino** + +**The application form will be available in the** [**Technical Writer Guide**](https://developers.google.com/season-of-docs/docs/tech-writer-guide) **during the technical writer application phase.** + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the GSoD application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [**Get Involved Guide**](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [**ask questions the smart way**](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our ****[**SLACK**](http://codeuino.slack.com) channel. Here is the ****[**link to join the communication channel**](http://slack.codeuino.org). +5. **Introduce yourself** within the community. +6. Run, Test and identify some potential documentation related issues in [**Codeuino Github Repositories**](https://github.com/codeuino)\*\*\*\* +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about GSoD** by understanding it and reading about it on their [**Manual**](https://developers.google.com/season-of-docs/docs/tech-writer-guide)\*\*\*\* + +#### **NOTE: Students can also propose their own ideas that they want to include within the community which they feel like there needs to be an improvement in the documentation.** + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including GSoD. If you don't have a blog yet, you should create one and you would be asked to write within the community guidelines. **You will be required to write a blog post every week about your planning work and project progress during GSoD. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#gsod channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of GSoD + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your GSoD project, and for other topics that interest you. +4. **Present your project in events, Conferences and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. The person who is willing to mentor takes up the project within the community and propose it under GSoD on the basis of involvement and prior knowledge of tech writing in it. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +**Consider proposing your own ideas as well that match the community project style**. + +Make sure you get through the **"**[**Mentor Guide**](https://developers.google.com/season-of-docs/docs/mentor-guide)**"** + +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Season of Docs organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + +## **Project Ideas** + +### **IDEA 1: Refactoring General Community and DONUT project Docs** + +### **Priority:** + +High + +### **Description:** + +#### This is a long run project and the Technical Writer is required to work on two parts under this section. + +**PART 1:** [**Donut Platform**](https://github.com/codeuino/Social-Platform-Donut) is a flexible open source **Social Network Kit that aims** to give you the customized social network, social intranet or huge social enterprise application for communities that really fits their needs. + +Technical Writer is asked to elaborate on each part of the project through documenting the docs for **Front-end**, **Back-end API Docs** and **Design work flow**. + +**Front-end Docs**: You are required to work on the Installation Guide and Configured modules including the Admin Dashboard work flows which can be achieved by the moderators for this platform. Development of configuration mechanism is one of our newest additions to our installation frameworks of Donut Platform. Currently Donut is central hosted but aims to get bundled as FOSS/OSS tool. So, the task of this major project is to draft an **Admin Management System** that will allow individuals or community admins to setup for themselves. To simplify the configuration, these predefined modules will have the most common use cases with different options for modules and settings while setting up this environment. Some examples of modules include: Login/Sign Up Authentications, Real time Notification,etc. + +**Back-end Docs:** Server Side includes drafting the docs for the APIs for POST, EVENTS and PROJECTS. + +**Design Workflow:** [**Understanding the UI/UX layouts**](https://www.figma.com/file/iZvb7rLYRp3Di3wILVQ7V9/CodeUino-Donut?node-id=0%3A1) and drafting those steps and explanation for various things used within it. Within the design tech writer has to define all the colors, fonts, styles and much necessary things. + +**PART 2:** This part contains refactoring the general documentation for the community; explaining the vision and mission, community guidelines, contributor page and FAQ about Community. + +**All the Community Docs can be found at** [**docs.codeuino.org**](../codeuino-docs.md)\*\*\*\* + +{% hint style="warning" %} +**References:** [**Open Collective Guide**](https://docs.opencollective.com/help/about/introduction)**,** [**Slack Documentation**](https://slack.com/intl/en-in/help)\*\*\*\* +{% endhint %} + +### **Required Skills/knowledge:** + +* Good knowledge of Markdown/writing +* Brief knowledge of project DONUT +* UI/UX experience is also required + +### **Difficulty Level:** + +Moderate + +### **Expected Outcome:** + +This task will have a well formatted documentation that will help users to surf about it easily. + +### **Potential Mentors:** + + [**Devesh Verma** ](https://github.com/devesh-verma) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren)\*\*\*\* + +\*\*\*\* + +### **IDEA 2: Writing API docs for codebadge bot and machine learning module for Codebadge project** + +### **Priority:** + +High + +### **Description:** + +This is a long run project and the Technical Writer is required to work on two parts under this section. CodeBadge is a project which considers official GitHub API and makes a fading badges graph for each organization. It contains two user interaction panels. Admin panel and codebadge bot. Admin panel is admin setup and dashboard section where user can set up the organization account with codebadge once he has installed codebadge bot for the Github organization. The codebadge bot will interact on the Github panel in the comment section of issues and pull request. The user will be updated of the badge updates and also if any comment has been detected inappropriate. The contributors will be allotted points for any kind of contribution to the project and will be assigned badges accordingly. This project will mainly be focused on writing bot related documentation and machine learning documentation. + +**Codebadge Bot:** You are required to work on the Installation Guide and Configured the app. You will need to elaborate on what are the event calls the bot will be triggered and how will the point system will work along with the bot in coordination with these requests. There is a need for proper API documentation for each event being handled by the bot. The major requirement to work on this section is to understand what all rules the point are allowed and when will bot trigger to comment on this section. + +**Machine Learning Module:** You are required to write docs for machine learning module. All the machine learning API request handled by flask API. There are two separate sections for which module handles ML request:- + +1. Github events:- the module analysis lots of events such as comments for hate speech, issue summarization and issue importance analysis. + +2. Illustrator events:- Codebadge illustrator events are all image-based machine learning handled requests. + +Requirement:- Basic experience with probot Github app and how Github events work. + +**All the Community Docs can be found at docs.codeuino.org** + +**References:** [**Open Collective Guide**](https://docs.opencollective.com/help/about/introduction)**,** [**Slack Documentation**](https://slack.com/intl/en-in/help) + +### **Required Skills/knowledge:** + +* Good knowledge of Markdown/writing +* Brief knowledge of project Codebadge +* experience with machine learning and image processing +* experience of working with probot + +### **Difficulty Level:** + +Moderate + +### **Expected Outcome:** + +This task will have well-formatted documentation that will help users to surf about it easily. + +### **Potential Mentors:** + +[**Devesh Verma**](https://github.com/devesh-verma)**,** [**Vaibhav D. Aren**](https://github.com/vaibhavdaren) **and** [**Ayush Nagar**](https://github.com/ayushnagar123) + +### **IDEA** **3:** **Detailed Frontend and Backend docs for Codebadge Project** + +### **Priority:** + +High + +### **Description:** + +This is a long run project and the Technical Writer is required to work on two parts under this section. CodeBadge is a project which considers official GitHub API and makes a fading badges graph for each organization. It contains two user interaction panels. Admin panel and codebadge bot. Admin panel is admin setup and dashboard section where user can set up the organization account with codebadge once he has installed codebadge bot for the Github organization. The codebadge bot will interact on the Github panel in the comment section of issues and pull request. The user will be updated of the badge updates and also if any comment has been detected inappropriate. The contributors will be allotted points for any kind of contribution to the project and will be assigned badges accordingly. This project will mainly be focused on writing frontend and backend related documentation. + +Technical Writer is asked to elaborate on each part of the project through documenting the docs for **Front-end**, **Back-end API Docs** and **Design work flow**. + +**Front-end Docs**: You are required to work on the Installation Guide and Configured modules including the Admin Dashboard work flows which can be achieved by the moderators for this platform. Frontend will have two types of login through github views:- 1. Admin view 2. Contributor view. You need to design docs for both the types of login workflow. + +**Back-end Docs:** Server Side includes drafting the docs for the APIs for POST, EVENTS and PROJECTS. + +**Design Workflow:** [**Understanding the UI/UX layouts**](https://www.figma.com/file/iZvb7rLYRp3Di3wILVQ7V9/CodeUino-Donut?node-id=0%3A1) and drafting those steps and explanation for various things used within it. Within the design tech writer has to define all the colors, fonts, styles and much necessary things. + +**All the Community Docs can be found at** [**docs.codeuino.org**](file:///@codeuino/s/documentation/~/drafts/-M5c2vy4h774_aFWfVxW/codeuino-docs) + +**References:** [**Open Collective Guide**](https://docs.opencollective.com/help/about/introduction)**,** [**Slack Documentation**](https://slack.com/intl/en-in/help) + +### **Required Skills/knowledge:**‌ + +* Good knowledge of Markdown/writing +* Brief knowledge of project Codebadge project +* UI/UX experience is also required + +### **Difficulty Level:** + +Moderate + +### **Expected Outcome:** + +This task will have a well formatted documentation that will help users to surf about it easily. + +### **Potential Mentors:** + +[**Devesh Verma**](https://github.com/devesh-verma)**,** [**Vaibhav D. Aren**](https://github.com/vaibhavdaren) **and** [**Ayush Nagar**](https://github.com/ayushnagar123)\*\*\*\* + + + + + diff --git a/activities/google-summer-of-code-2019/README.md b/activities/google-summer-of-code-2019/README.md new file mode 100644 index 0000000..11024c4 --- /dev/null +++ b/activities/google-summer-of-code-2019/README.md @@ -0,0 +1,96 @@ +# Google-Summer-Of-Code-2019 + +## **Welcome to the Google Summer of Code 2019** + +​[**Google Summer of Code**](https://summerofcode.withgoogle.com/) is a global program which encourages university students aged 18 or over to participate with open source projects during their summer vacations from schools and gain exposure to real-world software development scenarios and the opportunity for employment in areas related to their academic pursuits by drilling up their skills. + +Google awards stipends, to all successful students who complete their free and open-source projects under [**Codeuino**](http://www.codeuino.org/). Alongside Codeuino community members volunteer as "mentors" to students, who assist them about their summer projects and succeed their projects in an expected way. + +To learn more about this year's event and how GSoC works, please refer to the [**Frequently Asked Question \(FAQ\)**](https://developers.google.com/open-source/gsoc/faq). + +**We had applied to Google Summer of Code 2019, accepted organizations were announced on February 26. Though we could not make to it as an independent organisation but was able to participate as a sub organisation under "**[**JBOSS Community**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino)**" where they vouched for us.** + +**We had many** [**project ideas**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino) **posted, and we welcome potential students and mentors to reach out to us for further involvement.** + +## **About Codeuino** + +​[**Codeuino**](http://www.codeuino.org/) is a volunteer-driven open source Social networking organisation that provides various robust frameworks solutions which could span the entire world through building all kinds of social environments, discussion portals and collaboration platforms, giving prospectus to various other organisations, users and outreachers to use social media in a custom way. + +​[**DONUT**](https://github.com/codeuino/Social-Platform-Donut) is a major project of [**Codeuino**](http://www.codeuino.org/) that builds social networking Kit for various organisations to build up social environment \(like [**Facebook**](http://www.facebook.com/)**,**[**Twitter**](http://www.twitter.com/),etc\) for their organisation as well as for users to experience FOSS social environment and to showcase their productivity and services for their community along with the collaboration platform to interact with one another. This project stands similar to **"**[**Facebook**](https://facebook.com/)**"**, **"**[**Twitter**](https://twitter.com/)**"** like social medias. + +The community is a group of young open source contributors creatively leveraging our expertise in social networking and development projects to improve the quality of outreaching, interaction and collaboration for the people in developing nations. Everyone at Codeuino contributes to increase efficiency, outreaching for the user and expedite idea generation for social networking. + +If you are looking for a project which incorporates structured data and social networking medias then check out our [**project ideas page**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino) we had in 2019 and contact us though any communication channel described here. + +## Selected Project Ideas for GSOC 2019 + +## **Get in Touch with us** + +This was our first-time participation in [GSOC 2019](https://summerofcode.withgoogle.com/archive/2019/projects/6567045829754880/) and the Organisation administrator were [Jaskirat Singh](https://twitter.com/jaskirat626) followed by co-organisation administrator [Devesh Verma](https://twitter.com/devesh__verma)​ + +* **Email:** [**Jaskirat SIngh**](mailto:juskirat2000@gmail.com) and [**Devesh Verma**](mailto:deveshverma619@gmail.com) + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **SLACK Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org)\*\*\*\* +* **Contact Email:** [gsoc@codeuino.or](mailto:gsoc@codeuino.org) + +## **Involving as a Student** + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the GSoC application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [Get Involved Guide](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our [SLACK](http://codeuino.slack.com/) channel. Here is the [link to join the communication channel](http://slack.codeuino.org/). +5. **Introduce yourself** within the community. +6. Run, Test and identity some potential issues in [Codeuino Github Repositories](https://github.com/codeuino)​ +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about GSOC** by understanding it and reading about it on [Wikipedia](https://en.wikipedia.org/wiki/Google_Summer_of_Code) and getting through [GSOC Student Manual](https://google.github.io/gsocguides/student/)​ + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including GSoC. If you don't have a blog yet, you should create one. **You will be required to write a blog post every week about your planning work and project progress during GSoC. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#GSOC channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of GSOC + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your GSoC project, and for other topics that interest you. +4. **Present your project in events, Conferemnces and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +Consider proposing your own ideas that match the community project style. + +Make sure you get through the followings: + +* * * +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Summer of Code organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + +​ + +​ + diff --git a/activities/google-summer-of-code-2019/gsoc-2019-ideas.md b/activities/google-summer-of-code-2019/gsoc-2019-ideas.md new file mode 100644 index 0000000..cc9d279 --- /dev/null +++ b/activities/google-summer-of-code-2019/gsoc-2019-ideas.md @@ -0,0 +1,268 @@ +# GSOC-2019-Ideas + +**Welcome to our Google Summer Of Code 2019 ideas page. As a student, you are welcome to pick any of the ideas listed below and start early in the community bonding process as well as learning a bit about our code if we get selected as a mentoring organization. And of course, we'd love you to stay around even if we are not invited to GSoC or if we cannot invite you as a student.** + +Students can connect with the Mentors through various communication channels given below: + +* * * +All tasks on this page already indicate mentors for the task. New tasks on this page should be added only by those with the experience and time to invest in mentoring new developers. + +Check out [**Google Summer of Code 2019 with Codeuino**]() to know more about community participation. + +## **1. Development of modules with new UI/UX** + +**Priority:** High + +**Description:** + +Developing configuration mechanism is one of our newest additions to our installation frameworks of [**DONUT Platform**](https://github.com/codeuino/Social-Platform-Donut). The task of this major project is to develop a minimum of 12 different Modules for the social environment \([**DONUT platform**](https://github.com/codeuino/Social-Platform-Donut)\) along with a good looking User Interface architecture. To simplify the configuration, these predefined modules will have the most common use cases with different options for modules and settings while setting up this environment. Few have been described below which would serve essential features but make sure you meet the minimum criteria \(12\) for these. + +1.\) Defining the Security Settings + +* External users can register \(show registration form on login\) +* Allow access for non-registered users to public content \(guest access\) + +2.\) Setup independent Modules for following: + +* Notification \( This widget will show upcoming notifications on the dashboard \)[**Issue to work**](https://github.com/codeuino/Social-Platform-Donut/issues/13)​ +* Tasks Manager \( This will help to form tasks/assigns tasks/track tasks \) +* building Forms that will help users to post their projects/events/articles/etc +* Formatting Tool \( It will Help in formatting the content which can be written to post something \) +* Most Active Projects/People/posts/articles \(Defining most active people and most viewed projects \) + +3.\) Sample data Content + +* This part will consists of developing Dashboards for organization and Users differently depending upon who signed up. [**Issue to work**](https://github.com/codeuino/Social-Platform-Donut/issues/27)​ +* Developing "Pages" just like we have in [**Facebook**](http://www.facebook.com/) \( This is the main part of the project as it will help the users or community to develop pages for their "project"/"events"/internships or any other related things in order to showcase it in profound way\) + +**These modules should be developed with appropriate User Interface\(i.e. front-end part\) as well as back-end code with better User Experience.** [**Know more about Donut here**](http://www.codeuino.org/projects.html)​ + +**Required Skills/Knowledge:** + +* Good knowledge of Modules with packaging +* languages such as Python, Node Js, JavaScript, HTML, and CSS. +* UI/UX experience is also required with unique approach. + +**Difficulty:** High + +**Expected Outcome:** + +This project would result in formation of packaged modules with new User Interface that would help the users and various communities to get predefined things configured on initial installing or setting up. + +**Potential Mentors:** + +* ​[Jaskirat SIngh](https://github.com/jaskirat2000), IRC Nickname: jaskiratsingh, SLACK name: @jaskirat, email: juskirat2000@gmail.com +* ​[Devesh Verma](https://github.com/devshiva619), IRC Nickname: devesh\_verma, SLACK name: @devesh, email: deveshverma619@gmail.com +* ​[Vaibhav Aren](https://github.com/vaibhavdaren), IRC Nickname: vaibhavdaren, SLACK name: @vaibhavdaren, email: vaibhavdaren@gmail.com +* ​[Pratul kumar](https://github.com/Pratul1997), IRC Nickname: Pratul1997, SLACK name: @pratul1997, email: pratulkumar1997@gmail.com +* ​[Ifeanyi Ekperi](https://github.com/ifeanyiekperi), IRC Nickname: ifeanyi\_, SLACK name: @ifeanyiekperi, email: imattew3@gmail.com +* ​[Uphaar Dubey](https://github.com/capedcrusader23), IRC Nickname: uphaar dubey SLACK: @Ccrusader, email:uphaar23dubey@gmail.com + +**Priority:** High + +**Description:** + +The [**DONUT Platform**](https://github.com/codeuino/Social-Platform-Donut) contains the notification feature which helps users to accommodate things in easy way. So the task of this project is to develop a mechanism for **"tags"** [**Explanation of tags in posts by WordPress**](https://en.support.wordpress.com/posts/tags/)**.** These tags will provide a useful way to group related posts together and and to quickly tell readers what a post is about and where to redirect or highlight the particular post more. The mechanism should be developed in such a way that users can make their own tags or can also select from predefined tags\(this needs to be built\) which gets automatically saved at one place that can be called as tag cloud and while submitting any posts it should get redirected to the appropriate users/groups which contains the similar tags.The tag cloud needs to be built which can store all the tags. When someone viewing your blog/project/article/any other post, clicks on one of defined Tag links, a Tag archive page with all the posts belonging to that Tag, should be displayed should also get displayed. + +**Lets Understand this with example** + +Assume that **"X"** user signs up on the DONUT platform. Once the **"X"** user has defined all the details about himself, then he would be asked to select some tags from the tags cloud which describes him the best and here, **"X"** user chooses "Designer", "Nodejs" and "Html". this tells us from the description of the tags in the tags cloud that this **"X"** user is a "Designer" and knows languages like "Nodejs" and "Html".On pursuing further these tags get stored for him. + +Now assume other user **"Y"**, suppose "Y" user is already logged into this platform. **"Y"** user writes a post as project/article/blog or any other thing related to feeds on it, before he publishes, he would be asked to choose some tags from the "Tags Cloud". Suppose the **"Y"** user choose "Nodejs" tag from it. **Here, we see that user "X" and "Y" has "Nodejs" common in them.** So on publishing the post by user **"Y"**, the particular project would be redirected to the **"X"**\(because they both contain common tags\), **According to the tags description user "X" would be able to review the thing.** + +**"X" and "Y" can be users as well as communities.** + +Few things to be considered while developing the tags module as: + +* Minimum of 50 predefined tags are required with different colors. +* Users can also make custom tags +* Some required items can be inspired from [**here**](https://codex.wordpress.org/Posts_Tags_Screen)​ +* Should be well formatted in the table in the "tags cloud" with tag name and descriptions required. +* giving access to the users to delete custom made tags as well as edit custom made tags. + +Another objective is to develop a module using APIs with which communities admins will be able to gather meaningful insights from the various conversation happening in various phases of the DONUT platform. But, sometimes, it becomes difficult for the admin to personally go through all the Activities that are happening within the channels of this platform like people posting various things, tagging and introducing new projects, etc. This is where an analytics tool could save the day for admins. This project aims at developing a module to retrieve and show meaningful information to admins which could help them remain updated with all the happenings within the community. This should result in the formation of a Summary sheet which can also be notified through emails to them. + +Following are the basic feature which should be supported by the analytics module: + +* Admin should be able to track all the members within the community +* Users privacy should be kept secure and safe and no one other than community admin should be able to access any conversation +* The data should be collected and organized in the proper way to extract meaningful information. It should also help admin to understand community members behavior and trigger automation workflows +* The analysis should show key trends, how many members are active and are responding which should help him make a future decision. +* The report should be updated in real-time. +* Admin should be able to export the report generated in CSV/PDf format. +* The proper user interface should be used to make the report attacking and readable. + +**Required Knowledge:** + +* Good knowledge about data analytics and commonly used analytics tool +* Prior experience with Data analytics or data collection +* Technologies required: Python, HTML, CSS, Python Libraries like numpy, Matplotlib etc. +* Converting analytics report in PDF or CSV format +* Prior experience of NLP and semantic analysis will be an added advantage + +**Required Skills/Knowledge:** + +* Good knowledge of Modules with packaging +* languages such as Python, Node Js, JavaScript, HTML, and CSS. +* Good knowledge about data analytics and commonly used analytics tool +* Prior experience with Data analytics or data collection +* Technologies required: Python, HTML, CSS, Python Libraries like numpy, Matplotlib etc. +* Converting analytics report in PDF or CSV format +* Prior experience of NLP and semantic analysis will be an added advantage + +**Difficulty:** Moderate + +**Expected Outcome:** + +This tag module will help users to review group related posts together and to quickly tell readers what a post is about by supporting them in their projects if needed. Tags also make it easier for people to find content as well as describe your own tag in better way. + +**Potential Mentors:** + +* ​[Jaskirat SIngh](https://github.com/jaskirat2000), IRC Nickname: jaskiratsingh, SLACK name: @jaskirat, email: juskirat2000@gmail.com +* ​[Prateek Chanda](https://github.com/prateekiiest), IRC Nickname:prateekiiest, SLACK name: @prateekiiest, email:prateekkol21@gmail.com; +* ​[Devesh Verma](https://github.com/devshiva619), IRC Nickname: devesh\_verma, SLACK name: @devesh, email: deveshverma619@gmail.com +* ​[Vaibhav Aren](https://github.com/vaibhavdaren), IRC Nickname: vaibhavdaren, SLACK name: @vaibhavdaren, email: vaibhavdaren@gmail.com +* ​[Pratul kumar](https://github.com/Pratul1997), IRC Nickname: Pratul1997, SLACK name: @pratul1997, email: pratulkumar1997@gmail.com +* ​[Uphaar Dubey](https://github.com/capedcrusader23), IRC Nickname: uphaar dubey SLACK: @Ccrusader, email:uphaar23dubey@gmail.com +* ​[Pranjal Kumar](https://github.com/pranjalkumar), email:pranjalkumar8228@gmail.com, slack name:@pranjal + +**Priority:** Medium + +**Description:** + +The [**DONUT Platform**](https://github.com/codeuino/Social-Platform-Donut) already contains dashboard for users only but with new mission and aim DONUT platform can be used by an individual user as well as by the community. This project defines the purpose to give more profound look to the Admins dashboards for the **"users"** and **"community"** differently. More and better user interface and user experience required that could fulfill the requirements for the users and community admins. + +Since for the community, only a single user can register/sign up for their community, so the community admin\( person who register/signs up\)should have all the access. Few things/features described below. + +* Admins can add members to the community. +* Blocking users \( Giving access to block people\) +* Analytical representation \(This will help community view stat for their posts which can be shown through popularity/most viewed,etc \) +* Contribution on various projects by making the APIs and integrating with the Github. +* Project/Articles/blogs and other feeds posted by community +* Comments made by people on any community post +* Profile with all details \(Giving access to delete any post\) +* Allowing to give them access for the "settings" of the community +* Activity logs \( This feature will describe about followings, comments, Upvote/Downvote, stare, pinned things\( posts/projects/events/etc\) + +You are welcome to add more features that can improve the UI/UX and result in good outcome. [**Look here at this example to see some UIs for dashboard**](https://wrapbootstrap.com/themes/admin)​ + +User Dashboard should includes the following things: + +* User profile \(with appropriate settings feature\) +* Activities log \( This feature will describe about followings, comments, Upvote/Downvote, stare, pinned things\( posts/projects/events/etc\) +* Groups \( Create, invite and manage your own groups \) +* blocking other users + +​[**DONUT Platform**](https://github.com/codeuino/Social-Platform-Donut) is an open source social networking platform that gives you the privilege of having your own social platform and use it in a custom way. So the purpose of this project is to develop a module that would help users to draft their posts in advance which can be posted accordingly and automatically after it has been scheduled with appropriate timing. + +**For instance**, if "X" user wants to publish his project/post on "Y date/day", then he will write their posts in advance in this tool and schedule it with appropriate timings/day/date. On particular "Y date/day" this post would automatically get published. This will help to save time and increase efficiency. + +The other part of this project is to integrate other social handles like **"**[**Facebook**](http://www.facebook.com/)**", "**[**Twitter**](http://www.twitter.com/)**", "**[**LinkedIn**](https://www.linkedin.com/)**", "**[**YouTube**](https://www.youtube.com/)**"** with the DONUT platform so that post can be shared on other social handles too. + +**Note:** This project requires additional minimum 10 features for both users as well as organisations apart from the above described ones. Creativity would be really appreciable and be taken into consideration. + +Initial dashboard code can be seen [**here**](https://github.com/codeuino/frontened/blob/master/User-dashboard.html)​ + +**Required Skills/Knowledge:** + +* Good knowledge of databases +* languages such as NodeJs, Html CSS, Bootstraps, JavaScript, React; +* Knowledge of visual representation +* Good knowledge of databases +* languages such as NodeJs, Html CSS, Bootstraps, JavaScript, React; +* Knowledge of visual representation + +**Difficulty:** Moderate + +**Expected Outcome:** + +This project would reward back with more user-friendly and better User experience dashboard along with a tool that will help users to save their post as a draft and share them anytime or automatically through Reminders. + +**Potential Mentors:** + +* ​[Aishwarya Srivastava](https://github.com/SriAish), IRC Nickname: SriAish, SLACK name: @SriAish, email: aishsrivastava1998@gmail.com +* ​[Vaibhav Aren](https://github.com/vaibhavdaren), IRC Nickname: vaibhavdaren, SLACK name: @vaibhavdaren, email: vaibhavdaren@gmail.com +* ​[Jaskirat SIngh](https://github.com/jaskirat2000), IRC Nickname: jaskiratsingh, SLACK name: @jaskirat, email: juskirat2000@gmail.com +* ​[Devesh Verma](https://github.com/devshiva619), IRC Nickname: devesh\_verma, SLACK name: @devesh, email: deveshverma619@gmail.com +* ​[Uphaar Dubey](https://github.com/capedcrusader23), IRC Nickname: uphaar dubey SLACK: @Ccrusader, email:uphaar23dubey@gmail.com + +**Priority:** Medium + +**Description:** + +The purpose of this project is to integrate task management tool for DONUT platform which will provide admins of the communities to organize the workflow using the concept of generating cards to showcase task. By making use of **Task Management tool** admins will be able to organise different types of tasks that has been achieved/to be achieved/in progress. + +Also, Task Management tool will have progress monitoring charts, to explain this in a better way the progress tracking will help in monitoring the development cycle of the projects. Using the progress tracking feature contributors will be well aware of the deadlines to finish a particular task. Also this will help better management of the communities. + +Following are the things that an integrated Task Management tool should have: + +* Automating the work flow \( This will set up triggering events to save time on project management that can move tasks into the right columns accordingly.\) +* Representing the progress made with the help of visualization +* Project boards are made up of issues and notes that are categorized as cards in columns of your choosing. These can drag and drop or use keyboard shortcuts to reorder cards within a column, move cards from column to column, and change the order of columns. +* Creating notes within columns with appropriate **formatting tool** +* Able to add task reminders, references to issues and pull requests from any repository on GitHub, or to add information related to the project board. +* Allowing selecting things with the help of **checklist** added +* Notifying assignee through email if any comment made or tagged. + +**Note:** This project can be achieved by integration of task managment tools from [**Github**](https://help.github.com/articles/about-project-boards/)**,** [**Trello**](https://trello.com/) and other tools that can result in same outcome. + +**Required Skills/Knowledge:** + +* Good knowledge of Integration +* Knowledge of working in project boards of GitHub and Trello +* languages such as NodeJs, Html CSS, Bootstraps, JavaScript, React; +* Knowledge of visual representation + +**Difficulty:** Moderate + +**Expected Outcome:** + +With integrated tool communities would be able to track progress and will able to generate task for members. + +**Potential Mentors:** + +* ​[Aishwarya Srivastava](https://github.com/SriAish), IRC Nickname: SriAish, SLACK name: @SriAish, email: aishsrivastava1998@gmail.com +* ​[Vaibhav Aren](https://github.com/vaibhavdaren), IRC Nickname: vaibhavdaren, SLACK name: @vaibhavdaren, email: vaibhavdaren@gmail.com +* ​[Devesh Verma](https://github.com/devshiva619), IRC Nickname: devesh\_verma, SLACK name: @devesh, email: deveshverma619@gmail.com +* ​[Uphaar Dubey](https://github.com/capedcrusader23), IRC Nickname: uphaar dubey SLACK: @Ccrusader, email:uphaar23dubey@gmail.com + +### **5. Integration of Chat functionality in DONUT Platform** + +**Priority:** Medium + +**Description:** + +Communication is an important part of the development cycle and for an efficient product, it's important that all the team members can communicate and coordinate accordingly. This is why we wish to provide a proper communication channel for developers where they can discuss about any new development in their project, can share their ideas with their team members or even plan a team meeting. This project aims at integrating various chat platforms like [**Slack**](https://slack.com/), [**Gitter**](https://gitter.im/), and [**IRC**](https://webchat.freenode.net/) with the **DONUT** platform. Since **DONUT** is an open source platform, community leaders and team leaders should be able to create a channel or add or remove members from the channel. This project would require integration through making APIs. + +Following the basic feature which should be supported by the chat platform: + +* Secure Integration with various chat platforms like Slack, Gitter, and IRC using their APIs +* User experience should be a top priority while developing the chat functionality so that even a new developer finds is very easy +* User privacy should be a top priority +* Team leaders or organization Leaders should be able to create a different channel where they could add to remove members +* Notification feature in case of an emergency message with the group of which a particular user is a part of, either via text message or email. +* To perform meaningful analytics across various chat platforms and an efficient way to manage them +* Video communication platforms should also be integrated as an additional feature for effective team meetings. +* The efficient way to handle the large traffic in case of video communication + +**Note:** The above-mentioned communication platforms are just the examples and any new platforms can also be added and integrated + +**Required Knowledge:** + +* Good Knowledge about integration +* Prior experience of working with any chat functionalities. +* Understanding the security concern and way to tackle them +* Prior working experience with WebRTC +* Technologies required: HTML, CSS, JavaScript, Redux, NodeJS, WebRTC + +**Difficulty:** Moderate + +**Expected Outcome:** + +With the integration of proper communication channel, the communities should be able to communicate and coordinate any project. + +**Potential Mentors:** + +* ​[Pranjal Kumar](https://github.com/pranjalkumar), email:pranjalkumar8228@gmail.com, slack name:@pranjal +* ​[Uphaar Dubey](https://github.com/capedcrusader23), IRC Nickname: uphaar dubey SLACK: @Ccrusader, email:uphaar23dubey@gmail.com + diff --git a/activities/google-summer-of-code-2021/README.md b/activities/google-summer-of-code-2021/README.md new file mode 100644 index 0000000..6da6356 --- /dev/null +++ b/activities/google-summer-of-code-2021/README.md @@ -0,0 +1,82 @@ +# Google-Summer-Of-Code-2021 + +## **Welcome to the Google Summer of Code 2021** + +​[**Google Summer of Code**](https://summerofcode.withgoogle.com/) is a global program which encourages university students aged 18 or over to participate with open source projects during their summer vacations from schools and gain exposure to real-world software development scenarios and the opportunity for employment in areas related to their academic pursuits by drilling up their skills. + +Google awards stipends, to all successful students who complete their free and open-source projects under [**Codeuino**](http://www.codeuino.org/). Alongside Codeuino community members volunteer as "mentors" to students, who assist them about their summer projects and succeed their projects in an expected way. + +To learn more about this year's event and how GSoC works, please refer to the [**Frequently Asked Question \(FAQ\)**](https://developers.google.com/open-source/gsoc/faq). + +**We are glad to apply to Google Summer of Code 2021 as a mentoring organisation, accepted organizations will be announced on March 9. In the meanwhile feel free to move around and connect with the community.** + +**We have many** [**project ideas**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2021-idea-page) **posted, and we welcome potential students and mentors to reach out to us for further involvement.** + +## **About Codeuino** + +​[**Codeuino**](http://www.codeuino.org/) is a volunteer-driven open source Social networking organisation that provides various robust frameworks solutions which could span the entire world through building all kinds of social environments, discussion portals and collaboration platforms, giving prospectus to various other organisations, users and outreachers to use social media in a custom way. + +​[**DONUT**](https://github.com/codeuino/Social-Platform-Donut) is a major project of [**Codeuino**](http://www.codeuino.org/) that builds social networking Kit for various organisations to build up social environment \(like [**Facebook**](http://www.facebook.com/)**,**[**Twitter**](http://www.twitter.com/),etc\) for their organisation as well as for users to experience FOSS social environment and to showcase their productivity and services for their community along with the collaboration platform to interact with one another. This project stands similar to **"**[**Facebook**](https://facebook.com/)**"**, **"**[**Twitter**](https://twitter.com/)**"** like social medias. + +The community is a group of young open source contributors creatively leveraging our expertise in social networking and development projects to improve the quality of outreaching, interaction and collaboration for the people in developing nations. Everyone at Codeuino contributes to increase efficiency, outreaching for the user and expedite idea generation for social networking. + +## Selected Project Ideas for GSOC 2021 + +## **Involving as a Student** + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the GSoC application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [Get Involved Guide](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our [SLACK](http://codeuino.slack.com/) channel. Here is the [link to join the communication channel](http://slack.codeuino.org/). +5. **Introduce yourself** within the community. +6. Run, Test and identity some potential issues in [Codeuino Github Repositories](https://github.com/codeuino)​ +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about GSOC** by understanding it and reading about it on [Wikipedia](https://en.wikipedia.org/wiki/Google_Summer_of_Code) and getting through [GSOC Student Manual](https://google.github.io/gsocguides/student/)​ + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including GSoC. If you don't have a blog yet, you should create one. **You will be required to write a blog post every week about your planning work and project progress during GSoC. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#GSOC channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of GSOC + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your GSoC project, and for other topics that interest you. +4. **Present your project in events, Conferemnces and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +Consider proposing your own ideas that match the community project style. + +Make sure you get through the followings: + +* Have read [**Mentoring Guide**](https://google.github.io/gsocguides/mentor/) +* Have read [**Mentors responsibilities**](https://developers.google.com/open-source/gsoc/help/responsibilities#mentors_responsibilities) +* \*\*\*\*[**Assigned projects**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2021-idea-page)\*\*\*\* + +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Summer of Code organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + diff --git a/activities/google-summer-of-code-2021/gsoc-2021-idea-page.md b/activities/google-summer-of-code-2021/gsoc-2021-idea-page.md new file mode 100644 index 0000000..65ff050 --- /dev/null +++ b/activities/google-summer-of-code-2021/gsoc-2021-idea-page.md @@ -0,0 +1,308 @@ +# GSoC 2021 Idea Page + +**Welcome to our Google Summer of Code 2021 ideas page. As a student, you are welcome to pick any of the ideas listed below and start early in the community bonding process as well as learning a bit about our code if we get selected as a mentoring organization. And of course, we'd love you to stay around even if we are not invited to GSoC or if we cannot invite you as a student.** + +Students can connect with the Org Admins, Mentors, and other community members through various communication channels given below: + +* **Email:** **Jaskirat Singh** and **Siddharth Simharaju** **\(Org Admins\)** + + + Students and Mentors can join the slack discussion portal in order to carry discussions about their projects and interaction within the community. + +* **Slack Workplace** - [**http://slack.codeuino.org/**](http://slack.codeuino.org/)\*\*\*\* + +All tasks on this page already indicate mentors for the task. New tasks on this page should be added only by those with the experience and time to invest in mentoring new developers. + +**Make sure to Check out** [**Google Summer of Code 2021**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021) **to know more about community participation in GSoC 2021.** + +## **Table of Contents** + +* [**IDEA 1: Refactoring and Improving Donut Platform Interaction**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2020-idea-page#idea-1-refactoring-and-improving-donut-platform-interaction)\*\*\*\* +* \*\*\*\*[**IDEA 2: Cross-Platform Hybrid Mobile Application for Donut**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2020-idea-page#idea-2-cross-platform-hybrid-mobile-application-for-donut)\*\*\*\* +* \*\*\*\*[**IDEA 3: Development of Event Management System inside Donut**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2020-idea-page#idea-3-development-of-event-management-system-inside-donut)\*\*\*\* +* \*\*\*\*[**IDEA 4: Visualizer Representation of User Activity through Heatmap**](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2020-idea-page#idea-4-visualizer-representation-of-user-activity-through-heatmap)\*\*\*\* +* \*\*\*\*[**IDEA 5: Implementing Microservice architecture in Donut** ](https://docs.codeuino.org/documentation/activities/google-summer-of-code-2021/gsoc-2020-idea-page#idea-5-implementing-microservice-architecture-in-donut) + +## **IDEA 1: Refactoring and Improving Donut Platform Interaction** + +### **Priority:** + +High + +### Description: + +Donut is an open-source, feature-rich, highly flexible and privacy-friendly, social networking platform built for community-oriented collaboration in a customized way. It has been transitioning from development to a production phase, with a vision to have better scalability but it is required to evaluate through various testing, documentation, and elimination of all major level bugs which will allow an essential impetus to provide custom and friendly rich widgets and an expansive library of modules to make communication and collaboration easy and successful. So, it is required to refactor the whole existing codebase in order to build the powerful module system along with adding some minor features. + +Few major directed points that need to be accomplished are: + +* Maintaining design consistency across the whole application +* **Bug triaging** and **resolving** all pending bugs on backend and frontend repositories +* Restructuring code-base with introducing React Hooks and API's +* Writing unit test cases +* Making platform responsive +* Feature Addition: Implementation of the dark theme across the whole platform +* Deployment of Application: + * Deployment of Docker Image to Docker Hub and AWS ECS/ other cloud providers + * Setting up of clusters, server instances + * Creating network load balancers + * Adding SSL certification and handling cors. +* Monitoring Performance: + + * Improving front-end performance by following the LightHouse measures like optimizing build , minifying JS bundle size, lazy-loading, semantic elements etc. + * Use of Performance Hooks API for Node.JS + * Setting up Cloudwatch or similar tools on the cloud provider + + + +#### Steps to get started: + +* Setup Donut and explore its different features. +* Write developer and user guides. +* Refactor code to follow standard conventions and best practices. +* Propose a new feature and implement it. +* Get involved in the community, review code, share ideas, open issues, and more. + +### Required Skills / Knowledge: + +* Excellent knowledge of JavaScript, NodeJs and React. +* Experience with unit testing. Experience with Jest or other testing frameworks. +* Fair technical documentation skills. +* Some experience with cloud services like AWS, Azure, and GCP. Experience setting up servers \( Like Enginx, Apache \), cloud storage services are preferable. +* Experience with Containerization\(Docker & Kubernetes\). + +**Technologies Involved:** React, NodeJs, Jest, Docker, Cloud \(AWS, GCP, Azure\), Kubernetes + + + +### Expected Outcome: + +After the completion of this project, Donut will be able to transit towards the production phase with a new release and it will be deployed to a cloud service with fair scalability, properly handle requests from the web application and the to be developed mobile application. + +### Potential Mentors: + +Devesh Verma, Uphaar Dubhey, Shivay Lamba, and Jaskirat Singh + +## **IDEA 2: Cross-Platform Hybrid Mobile Application for Donut** + +### **Priority:** + +High + +### Description: + +Donut Platform is a highly flexible open**-**source Social Network Kit that aims to give you the customized social network, social intranet, or huge social enterprise application for communities that really fits their needs. Its frontend is made in React.JS and the backend is written in Node.JS. + +Major tasks in this project are : + +* Creation of cross-platform Application. + * Setting up of sample application + * Going through the UI/UX Designs on Figma and maintaining the design consistency across the application +* Development of designed screens for different personas. + * Signup/ Login Screen for normal users and admins, used for authentication. Also maintaining the external Google and Github OAuth. + * Feed Screen: Used to fetch latest posts on a timeline + * Side nav bar: Contains links to all screens + * User Profile Screen: Screen to show a user’s profile on the platform + * Edit Profile: To able to edit a user’s profile contents + * Insights Screen: Showcasing all the insights of a user which is seen from the web + * New Posts, Projects, and Events: Screens to create new posts, projects, and events that can be posted on Donut + * Implementation of the organizational screen which gives the org admins any rights to control the platform +* Implementation of Push Notifications + * Understanding how push notifications work + * Implementing push notifications using Firebase FCM/ Web Sockets +* Adding location-based services to Donut. +* Deployment of the application + * Writing test cases + * Uploading the app on Google Play Developer +* Gain a good understanding of React Native, React, and mobile application development. +* Setup Donut and explore its different features, find bugs, and open issues. +* Get involved in the community and contribute to our code, fix bugs, or propose new features. +* Implementation of sample mobile applications implementing existing donut features. +* Proposing new mobile app-specific features for donut and implementing proof of concepts. +* Having a basic knowledge of platform-specific features and their implementations. +* Writing tests using Jest \( for React \). + + + +### Required Skills / Knowledge: + +* Good knowledge of React Native and React. +* Some experience with native Android and iOS development. +* UI / UX experience. +* Cloud Services like GCP/AWS/Azure. + + + +### Expected Outcome: + +* A functional Android Mobile Application for Donut. +* Consistency across the web and mobile applications. +* Bug fixes completion + +### Potential Mentors: + +Devesh Verma, Jaskirat Singh, and Siddharth Simharaju + +## **IDEA 3: Development of Event Management System inside Donut** + +### **Priority:** + +High + +### Description: + +The development of an online event configuration mechanism is one of our newest additions to our feature frameworks of the Donut platform. So, the task of this major project is to develop an Event Management System with an integration of the Jitsi Meet platform that will allow individuals or community admins to set up themselves to host online events To simplify the configuration, the event management system will be divided into three different phases which are organizer space, speaker space, and audience space with various modules which will have the most common use cases while setting up this environment. + +Below is the development required within each space : + +**Organizer Space:** +It will be a space where the organizer or admins will have control over the whole event management mechanism including the speakers, and audience. + +* Admins can add members to the community spaces through Invites, also can invite others as an Admin/moderator due to which all the same rights will be shared with the other person. +* Blocking users \( Giving access to block people\). +* Add/Remove any independent modules like chat mechanism\(which will be used for live chat\). +* Showcase the backstage mechanism. +* Registrations - Designing the customized event's landing page which can be used to promote away and to sell tickets, manage registrations, and monitor signups from their own event dashboard. +* Giving Access to delete any post/comments, etc. +* Giving them access to change modules in between any time through toggle or any other available options such as Theme change, Removing/Adding any other modules. +* Making a feature of "Maintenance". with this no user should be able to login/signup . they should see a particular page of maintenance. These rights should be given to only admins. +* Allowing to give them access to the "settings" of the event mechanism for a community. + +**Speaker Space:** +It will be a space which will be used by the speakers for giving the sessions. + +* They should have the mechanism to share their presentations. +* Access to the chats and comments by the audience and organizers in a separate way. +* Access to the Backstage settings - speakers line up, etc. + +**Audience Space:** +It will be the general way to view the live or recorded events for the user. + +* It should have the access to do networking with the people through chats or comments +* They will also have the access to see the event information, speakers line up + +**Note:** We have already some of the designs made for this project which can be found on [Figma](https://www.figma.com/file/iZvb7rLYRp3Di3wILVQ7V9/CodeUino-Donut?node-id=3194%3A6085). + +#### + +#### Steps to get started: + +* Gain a good understanding of React Native, React +* Setup Donut and explore its different features, find bugs, and open issues. +* Get involved in the community and contribute to our code, fix bugs, or propose new features. +* Having a basic knowledge of platform-specific features and their implementations. +* Writing tests using Jest \( for React \). + + + +### Required Skills / Knowledge: + +* Excellent knowledge of JavaScript, NodeJs and React. +* Experience with unit testing. Experience with Jest or other testing frameworks. + +**Technologies Involved:** React Native, React, NodeJs, JavaScript + + + +### Expected Outcome + +* This project will result in having an appropriate event management mechanism inside the donut platform which can be used by the communities to create engaging virtual events that can connect people around the globe. +* It will also have different management spaces for the organizers, speaker, and audience +* It will have an integration of the Jitsi platform + +### Potential Mentors: + +Shivam Kumar, Devesh Verma, and Jaskirat Singh + +## **IDEA 4: Visualizer Representation of User Activity through Heatmap** + +### **Priority:** + +High + +### Description: + + A heat map is a graphical representation of data where values are depicted by color. Heat maps make it easy to visualize complex data and understand it at a glance and taking this into consideration this project states to implement the GitHub-like heatmap inside the donut platform which will give better insights to the respective users about their involvement inside the donut platform. + +This heatmap will show up the user's following contribution through building blocks : + +* The number of posts, the user has interacted with. +* The number of Likes and comments +* The number of projects uploaded +* The number of events organized/attended +* Some other functionalities + +It should also include the separate contribution activity section which will consist of a detailed timeline of the user involvement inside the donut platform, including comments made, post co-authored, new ideas proposed inside proposal functionality. It is made publically where other people on the platform can see any user's contributions over time by clicking on a specific date calendar. + +#### Steps to get started: + +* Gain a good understanding of React Native, React. +* Setup Donut and explore its different features, find bugs, and open issues. +* Get involved in the community and contribute to our code, fix bugs, or propose new features. +* Understand the working of Github heatmap +* Understand the importance and implementation of the heatmap +* Having a basic knowledge of platform-specific features and their implementations. + + + +### Required Skills / Knowledge: + +* Excellent knowledge of JavaScript, NodeJs and React. +* Experience with unit testing. Experience with Jest or other testing frameworks. +* Understanding of heatmap integration and development + +**Technologies Involved:** React Native, React, NodeJs, JavaScript + + + +### Expected Outcome: + +* This instance will help to give the activity overview section on anyone’s profile, also giving access to external viewers to see more information about the types of contributions/involvements the specific user has interacted with within the donut platform. +* This feature will also allow viewers to filter the contribution graph and activity timeline for any user. + +### Potential Mentors: + +Abhishek Naidu, Siddharth Simharaju, and Jaskirat Singh + +## **IDEA 5: Implementing Microservice architecture in Donut** + +### **Priority:** + +High + +### Description: + +Donut is an open source social networking platform. Currently, backend of Donut is a monolith made in NodeJs. Since donut is a social networking platform it should be able to handle a large number of requests simultaneously and scale up or down depending upon the traffic. For an application like Donut, not all services experience the same traffic so we would like to be able to scale up or down individual services loosely linked through API interfaces. Hence, we plan to shift the backend to microservice architecture. This task would require a significant portion of the backend to be re-written in Typescript. Also since there are obvious performance limitations in JavaScript we would be rewriting some crucial frequently used services in GoLang. Ultimately we would expect Ansible packages to be created to automate to a fair extent the deployment of Donut with the new architecture on various cloud platforms. Also since the backend of Donut would significantly change by this task, detailed in depth documentation and a developer's guide should be written. + +#### Steps to get started: + +* Gain good understanding of containers, container orchestration tools, micro service architecture and other related technologies. +* Setup Donut and explore its different features, find bugs and open issues. +* Get involved in the community and contribute to our code, fix bugs or propose new features. +* Implementation of a small version of Donut with microservice architecture with few core services and creation of Ansible packages to automate it's deployment. +* Understanding the various components of Donut and coming up with an architecture for microservices. + + + +### Required Skills / Knowledge: + +* Good knowledge of TypeScript and NodeJs. +* Experience with goLang. +* Some experience developing applications with microservice architecture. +* Fair amount of experience with containerization and container orchestration technologies like Docker and Kubernetes. +* Experience working with large codebases. +* Desire to learn about various open source best practices and adhere to them. +* Ability and passion for learning new concepts and technologies quickly and apply them on real world projects. + +**Technologies Involved:** JavaScript, TypeScript, Microservice architecture, GoLang, Docker, Kubernetes, Helm, Prometheus, Ansible, Cloud services \(AWS, GCP, Azure\) + + + +### Expected Outcome: + +* Completely functional bug free Donut with high availability and scalability made up of loosely coupled self contained microservices written in languages like GoLang and Typescript. +* Easily deployable Donut on major cloud platforms and for local development. It should be able to scale up or down automatically depending upon various metrics and perform optimally while requiring least amount of user intervention. Most of the tasks automated using Ansible and scripts. + +### Potential Mentors: + +Shivam Kumar, Devesh Verma, Abhishek Naidu, and Shivay Lamba + diff --git a/activities/gsoc-student-application-template.md b/activities/gsoc-student-application-template.md new file mode 100644 index 0000000..5190e21 --- /dev/null +++ b/activities/gsoc-student-application-template.md @@ -0,0 +1,63 @@ +--- +description: This is the student proposal template +--- + +# GSOC Student-Application-Template + +We will select the best proposals based on the following criteria: \(The quantity of students depends on the number of Codeuino projects accepted in GSoC\). + +* The quality of the proposal and its priority for its various projects. +* Engagement of the student with the community and potential mentors. +* Contributions by the student to the Project & Community. +* Contributing to other Open Source Projects is a bonus. + +## **Student Application guide** + +* Student proposals should be very specific and high priority based. We want to see evidence that you can succeed in the selected project. Applications with one-liners and general descriptions definitely won’t be encouraged. +* Students have to provide appropriate/actual contacts. The work done during GSoC requires some discipline as you have to plan your day-to-day activity by yourself. Nevertheless, you can expect regular contact with your mentors both via the usual means of communication for your project as well as personal guidance via email, chat or phone conferences. +* Describe the things as impressively as you can, including your demonstrations during community contributions. +* If you are unsure whether your proposal is suitable, feel free to discuss it on our various following discussions portals: +* **SLACK Discussion platform:** [**Join to interact with community!**](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ) +* **Email:** [**gsoc@codeuino.org**](mailto:gsoc@codeuino.org)\*\*\*\* + +We have many community members on our mailing list who will quickly answer any of your questions regarding the project. Mentors are also constantly monitoring the mailing list. Don’t hesitate to ask questions. We’d love to help you out! + +## **Proposal Requirements** + +The proposal will be submitted via the Google Summer Of Code website at [**https://summerofcode.withgoogle.com/**](https://summerofcode.withgoogle.com/) . We expect your application to be in the range of 1000-1200 words. Anything less than that will probably not contain enough information for us to determine whether or not you are the right person for the job. + +Your proposal should contain at least the following information, but feel free to include anything that you think is: + +### **About Yourself** + +* Your Full Name +* Your Email Address +* Your Slack Username +* Your IRC Username +* Your Country +* What is your primary language? \(We have volunteers including mentors who speak multiple languages and can match you with one of them if you'd prefer.\) +* Where are you located, and what hours do you tend to work? \(We also try to match mentors by general time zone if possible.\) +* Your hangouts handle \(with preferable time you are available to talk\) +* Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer with Codeuino? + +### **About Your Project** + +* Name of your project. +* Detailed description of your idea including an explanation on why it is innovative \(maybe you already have a prototype?\), what contribution do you expect to make to the Codeuino community and why do you think your project is needed. A rough plan of your development and possible architecture sketches, giving some UIs. +* Why do they need it?, What technologies \(programming languages, etc.\) will you be using? +* What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, tell us what you will be working on each week. \(As the summer goes on, you and your mentor will adjust your schedule, but it's good to have a plan at the beginning so you have an idea of where you're headed.\) Note that you should probably plan to have something "working and 90% done" by the midterm evaluation \(July 6-13\); the last steps always take longer than you think, and we will consider canceling projects which are not mostly working by then. +* Describe the working of your planned timelines. +* Detail the timeline explaining what the expected progress is for each week or every two weeks \(pay special attention to the milestones within the GSoC timeline itself, of course\) and how we should validate the results. +* Convince us, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant. + +### **Community Interaction** + +* What will you do if you get stuck on your project and your mentor isn't around? +* How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project? +* Mention your planned absences. We don't need you to detail what you will be doing when you are not working of course, but if you are going away for any reason we need to know so we don't think you've abandoned. +* Describe a great learning experience you had while working with your project. +* If you apply to more than one GSoC project, especially if you also apply for a project in another organization, specify which project you prefer. In case two organizations choose to accept your applications, we can then give you the project that is most important to you. Preferring the project of another organization will not influence our decision whether to accept your application. +* Anything else we should know about you? + +### **We are Looking forward to work with you! Good Luck** + diff --git a/activities/gsoc2020.md b/activities/gsoc2020.md new file mode 100644 index 0000000..4a54c67 --- /dev/null +++ b/activities/gsoc2020.md @@ -0,0 +1,111 @@ +--- +description: Description about Codeuino's Involvement in the GSOC'20 +--- + +# Google-Summer-Of-Code-2020 + +## **Welcome to the Google Summer of Code 2020** + +[**Google Summer of Code**](https://summerofcode.withgoogle.com) is a global program which encourages university students aged 18 or over to participate with open source projects during their summer vacations from schools and gain exposure to real-world software development scenarios and the opportunity for employment in areas related to their academic pursuits by drilling up their skills. + +Google awards stipends, to all successful students who complete their free and open-source projects under [**Codeuino**](http://www.codeuino.org/). Alongside Codeuino community members volunteer as "mentors" to students, who assist them about their summer projects and succeed their projects in an expected way. + +To learn more about this year's event and how GSoC works, please refer to the [**Frequently Asked Question \(FAQ\)**](https://developers.google.com/open-source/gsoc/faq). + +**We are glad to apply to Google Summer of Code 2020 as a mentoring organisation, accepted organizations will be announced on February 20. In the meanwhile feel free to move around and connect with the community.** + +**We have many** [**project ideas**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino) **posted, and we welcome potential students and mentors to reach out to us for further involvement.** + +## **About Codeuino** + +[**Codeuino**](http://www.codeuino.org) is a volunteer-driven non-profit open source Social networking organisation that provides various robust frameworks solutions which could span the entire world through building all kinds of social environments, discussion portals and collaboration platforms, giving prospectus to various other organisations, users and outreachers to use social media in a custom way. + +[**DONUT**](https://github.com/codeuino/Social-Platform-Donut) is a major project of [**Codeuino**](http://www.codeuino.org) that builds social networking Kit for various organisations to build up social environment \(like [**Facebook**](http://www.facebook.com)**,**[**Twitter**](http://www.twitter.com),etc\) for their organisation as well as for users to experience FOSS social environment and to showcase their productivity and services for their community along with the collaboration platform to interact with one another. This project stands similar to **"**[**Facebook**](https://facebook.com)**"**, **"**[**Twitter**](https://twitter.com)**"** like social medias. + +The community is a group of young open source contributors creatively leveraging our expertise in social networking and development projects to improve the quality of outreaching, interaction and collaboration for the people in developing nations. Everyone at Codeuino contributes to increase efficiency, outreaching for the user and expedite idea generation for social networking. + +If you are looking for a project which incorporates structured data and social networking medias then check out our [**project ideas page**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino) we had in 2019 and contact us though any communication channel described here. + +## Selected Project Ideas for GSOC 2020 + +| Project Name | Selected Student | Blog | Mentors | +| :--- | :--- | :--- | :--- | +| | | | | + +## **Get in Touch with us** + +This is our first-time participation in GSOC 2020 as an **"Independent Orgnisation" but we have been a part of GSOC 2019 as a sub organisation where "JBoss Community" vouched for us.** + +The Organisation administrators for GSOC 2020 are [Jaskirat Singh](https://twitter.com/jaskirat626) followed by co-organisation administrator [Devesh Verma](https://twitter.com/devesh__verma) + +* **Email:** [**Jaskirat SIngh**](mailto:juskirat2000@gmail.com) and [**Devesh Verma**](mailto:deveshverma619@gmail.com) + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **SLACK Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org) +* **Contact Email:** [gsoc@codeuino.org](mailto:gsoc@codeuino.org) + +## **Involving as a Student** + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the GSoC application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [Get Involved Guide](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our [SLACK](http://codeuino.slack.com) channel. Here is the [link to join the communication channel](http://slack.codeuino.org). +5. **Introduce yourself** within the community. +6. Run, Test and identity some potential issues in [Codeuino Github Repositories](https://github.com/codeuino) +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about GSOC** by understanding it and reading about it on [Wikipedia ](https://en.wikipedia.org/wiki/Google_Summer_of_Code)and getting through [GSOC Student Manual](https://google.github.io/gsocguides/student/) + +#### **NOTE: Students can also** [**propose their own ideas**](https://github.com/codeuino/GSOC/wiki/GSOC-2019-Ideas) **that they want to include within the community** + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including GSoC. If you don't have a blog yet, you should create one. **You will be required to write a blog post every week about your planning work and project progress during GSoC. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#GSOC channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of GSOC + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your GSoC project, and for other topics that interest you. +4. **Present your project in events, Conferemnces and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +Consider proposing your own ideas that match the community project style. + +Make sure you get through the followings: + +* Have read [**Mentoring Guide**](https://google.github.io/gsocguides/mentor/) +* Have read [**Mentors responsibilities**](https://developers.google.com/open-source/gsoc/help/responsibilities#mentors_responsibilities) +* [**Assigned projects**](https://github.com/codeuino/GSOC/wiki/GSOC-2019-Ideas) + +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Summer of Code organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + + + + + diff --git a/activities/gsoc2020/README.md b/activities/gsoc2020/README.md new file mode 100644 index 0000000..d1979e2 --- /dev/null +++ b/activities/gsoc2020/README.md @@ -0,0 +1,111 @@ +--- +description: Description about Codeuino's Involvement in the GSOC'20 +--- + +# Google-Summer-Of-Code-2020 + +## **Welcome to the Google Summer of Code 2020** + +[**Google Summer of Code**](https://summerofcode.withgoogle.com) is a global program which encourages university students aged 18 or over to participate with open source projects during their summer vacations from schools and gain exposure to real-world software development scenarios and the opportunity for employment in areas related to their academic pursuits by drilling up their skills. + +Google awards stipends, to all successful students who complete their free and open-source projects under [**Codeuino**](http://www.codeuino.org/). Alongside Codeuino community members volunteer as "mentors" to students, who assist them about their summer projects and succeed their projects in an expected way. + +To learn more about this year's event and how GSoC works, please refer to the [**Frequently Asked Question \(FAQ\)**](https://developers.google.com/open-source/gsoc/faq). + +**We are glad to apply to Google Summer of Code 2020 as a mentoring organisation, accepted organizations will be announced on February 20. In the meanwhile feel free to move around and connect with the community.** + +**We have many** [**project ideas**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino) **posted, and we welcome potential students and mentors to reach out to us for further involvement.** + +## **About Codeuino** + +[**Codeuino**](http://www.codeuino.org) is a volunteer-driven open source Social networking organisation that provides various robust frameworks solutions which could span the entire world through building all kinds of social environments, discussion portals and collaboration platforms, giving prospectus to various other organisations, users and outreachers to use social media in a custom way. + +[**DONUT**](https://github.com/codeuino/Social-Platform-Donut) is a major project of [**Codeuino**](http://www.codeuino.org) that builds social networking Kit for various organisations to build up social environment \(like [**Facebook**](http://www.facebook.com)**,**[**Twitter**](http://www.twitter.com),etc\) for their organisation as well as for users to experience FOSS social environment and to showcase their productivity and services for their community along with the collaboration platform to interact with one another. This project stands similar to **"**[**Facebook**](https://facebook.com)**"**, **"**[**Twitter**](https://twitter.com)**"** like social medias. + +The community is a group of young open source contributors creatively leveraging our expertise in social networking and development projects to improve the quality of outreaching, interaction and collaboration for the people in developing nations. Everyone at Codeuino contributes to increase efficiency, outreaching for the user and expedite idea generation for social networking. + +If you are looking for a project which incorporates structured data and social networking medias then check out our [**project ideas page**](https://developer.jboss.org/wiki/GSoC2019Ideas#jive_content_id_Category_Codeuino) we had in 2019 and contact us though any communication channel described here. + +## Selected Project Ideas for GSOC 2020 + +| Project Name | Selected Student | Blog | Mentors | +| :--- | :--- | :--- | :--- | +| | | | | + +## **Get in Touch with us** + +This is our first-time participation in GSOC 2020 as an **"Independent Orgnisation" but we have been a part of GSOC 2019 as a sub organisation where "JBoss Community" vouched for us.** + +The Organisation administrators for GSOC 2020 are [Jaskirat Singh](https://twitter.com/jaskirat626) followed by co-organisation administrator [Devesh Verma](https://twitter.com/devesh__verma) + +* **Email:** [**Jaskirat SIngh**](mailto:juskirat2000@gmail.com) and [**Devesh Verma**](mailto:deveshverma619@gmail.com) + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **SLACK Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org) +* **Contact Email:** [gsoc@codeuino.org](mailto:gsoc@codeuino.org) + +## **Involving as a Student** + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the GSoC application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [Get Involved Guide](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our [SLACK](http://codeuino.slack.com) channel. Here is the [link to join the communication channel](http://slack.codeuino.org). +5. **Introduce yourself** within the community. +6. Run, Test and identity some potential issues in [Codeuino Github Repositories](https://github.com/codeuino) +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about GSOC** by understanding it and reading about it on [Wikipedia ](https://en.wikipedia.org/wiki/Google_Summer_of_Code)and getting through [GSOC Student Manual](https://google.github.io/gsocguides/student/) + +#### **NOTE: Students can also** [**propose their own ideas**](https://github.com/codeuino/GSOC/wiki/GSOC-2019-Ideas) **that they want to include within the community** + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including GSoC. If you don't have a blog yet, you should create one. **You will be required to write a blog post every week about your planning work and project progress during GSoC. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#GSOC channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of GSOC + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your GSoC project, and for other topics that interest you. +4. **Present your project in events, Conferemnces and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +Consider proposing your own ideas that match the community project style. + +Make sure you get through the followings: + +* Have read [**Mentoring Guide**](https://google.github.io/gsocguides/mentor/) +* Have read [**Mentors responsibilities**](https://developers.google.com/open-source/gsoc/help/responsibilities#mentors_responsibilities) +* [**Assigned projects**](https://github.com/codeuino/GSOC/wiki/GSOC-2019-Ideas) + +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Summer of Code organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + + + + + diff --git a/activities/gsoc2020/gsoc2020-ideas/Badge_and_point_allotment_api.md b/activities/gsoc2020/gsoc2020-ideas/Badge_and_point_allotment_api.md new file mode 100644 index 0000000..84ac96a --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/Badge_and_point_allotment_api.md @@ -0,0 +1,19 @@ +# **Badge and point allotment Api** +**Priority:- High** +## Summary +In Codebadge, presently all the badge allotment computation are taking place at browser level. We require to shift all the badge related computation at backend using nodejs API. The task to be preformed under this task are:- +* Designing a database schema to manage user points for projects and organization, storing badge templates in efficient manner, storing admin defined pattern for awarding badges and special badges. +* Design a badge allotment api which shall fulfill following criterias:- + * Admin can decide the count of points for alloting points. + * Using Machine Learning allocating points as per past relatable issues. + * Designing a special badge allotment system which can be decided by the admin while creating an account. +* Designing an api system which returns renderable badges. Badges must be saved in minified format which shall be improved in quality and size on rendering time. +* Creating shareable illustrator system which admin can only share with his organization contributors using email/github username. +* Fetching contribution outside browser without using cron jobs approach which makes the computation speed slower. +## **Required Skills/knowledge:** +* Good knowledge of databases +* languages such as NodeJs +* experience of working sockets programming and using github apis +* Good Knowledge of Modules Bundling + +### Difficulty Level: Moderate diff --git a/activities/gsoc2020/gsoc2020-ideas/Comment_Management_API.md b/activities/gsoc2020/gsoc2020-ideas/Comment_Management_API.md new file mode 100644 index 0000000..d8a0fd8 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/Comment_Management_API.md @@ -0,0 +1,18 @@ +# **Comment Management API** +**Priority:- Moderate** +## **Summary** +* Creating a Webhook which fires when a comment is made on the issues/pull request. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* The comment must be analysed and decided how much the issue is relatable to the issue topic using machine learning. +* Reaction of other users shall award extra points for +ve comment and reduction in case of -ve comment/ reaction. +* Admin and maintainer +ve reactions and mentions must awarded with extra points. -ve reactions must be reflected in the same way. +* Comments must suggest the maintainer some contributor in case of issue. The person who has the most relatable comment must be suggested and shall be displayed on issue section. +* Inappropriate comments or language must be awarded a penalty. + +## **Required Skills/knowledge:** +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using github apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making Restfull API services + +## **Difficulty Level: Moderate** diff --git a/activities/gsoc2020/gsoc2020-ideas/Issue_Management_API.md b/activities/gsoc2020/gsoc2020-ideas/Issue_Management_API.md new file mode 100644 index 0000000..420019d --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/Issue_Management_API.md @@ -0,0 +1,20 @@ +# **Issue Management API** +**Priority:- Moderate** +## **Summary** +In Codebadge, presently all the badge allotment computation are taking place on the basis of comment count. We want to create a smarter approach to give each user its token of appreciation. Moreover CRON jobs approach which is being followed at present is pretty slow and hence need to optimise it. Trello dashboard being an awesome tool to manage Issue and pull requests is something we would like to take into consideration as a platform to manage the tasks and issues. The task to be performed under this project are:- +* Creating a Webhook which fires when a issue is made on the project. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* Admin dashboard interact with Trello to add a new card on related section by using classification algorithm of machine learning. +* Trello award points are set at issue card on trello which are awarded using badge and point allotment system. +* Issue award points must be visible on github issue section. +* Card must be moved or deleted respectively whenever needed on the basis of development. Awards must be updated in case of shift. +* Auto assigning issue on the basis of past issue solutions. +* Update database schema wherever required with an efficient schema design. +* Reward point updates in database for issue and updating badges on basis of points. +## **Required Skills/knowledge:** +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using github apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making Restfull API services + +## **Difficulty Level: Moderate** diff --git a/activities/gsoc2020/gsoc2020-ideas/Pull_Request_manager_API.md b/activities/gsoc2020/gsoc2020-ideas/Pull_Request_manager_API.md new file mode 100644 index 0000000..a41f39d --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/Pull_Request_manager_API.md @@ -0,0 +1,22 @@ +# **Pull Request manager API** +**Priority:- High** +## **Summary** +In Codebadge, presently all the badge allotment computation are taking place on the basis of comment count. We want to create a smarter approach to give each user its token of appreciation. Moreover CRON jobs approach which is being followed at present is pretty slow and hence need to optimise it. Trello dashboard being an awesome tool to manage Issue and pull requests is something we would like to take into consideration as a platform to manage the tasks and issues. The task to be performed under this project are:- +* Creating a Webhook which fires when a pull request is made on the project. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* Admin dashboard interact with Trello to check the award points if already set on trello cards. +* These awarded points must be updated in users section in the database. Remember maintainer’s merge commit shall not be awarded any point to the maintainer. +* If the trello dashboard has no such points in the card default points shall be awarded to the user which shall be decided by badge and point allotment api(which is a separate project). +* All the point updated that are made shall reflect in db. +* Update badges on the basis of total points +* Moving trello dashboard as per pull request merge usingv machine learning classification. +* Pull request award points must be visible for user on the respective pull request. +* Extra award points for an open issue. + +## **Required Skills/knowledge:** +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using github apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making restful API services + +## **Difficulty Level: Moderate** diff --git a/activities/gsoc2020/gsoc2020-ideas/README.md b/activities/gsoc2020/gsoc2020-ideas/README.md new file mode 100644 index 0000000..da19556 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/README.md @@ -0,0 +1,43 @@ +--- +description: This page contains the ideas list of GSoC 2020 +--- + +# GSoC 2020 Idea Page + +**Welcome to our Google Summer Of Code 2020 ideas page. As a student, you are welcome to pick any of the ideas listed below and start early in the community bonding process as well as learning a bit about our code if we get selected as a mentoring organization. And of course, we'd love you to stay around even if we are not invited to GSoC or if we cannot invite you as a student.** + +Students can connect with the Org Admins and Mentors through various communication channels given below: + +* **Email:** [**Jaskirat SIngh**](mailto:juskirat2000@gmail.com) and [**Devesh Verma**](mailto:deveshverma619@gmail.com) **\(Org Admins\)** + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **Slack Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org) +* **Community Contact Email:** [**gsoc@codeuino.org**](mailto:gsoc@codeuino.org) + +All tasks on this page already indicate mentors for the task. New tasks on this page should be added only by those with the experience and time to invest in mentoring new developers. + +**Make sure to Check out** [**Google Summer of Code 2020 with Codeuino**](https://docs.codeuino.org/documentation/activities/gsoc2020) **to know more about community participation in GSoC 2020.** + +## **IDEA LIST FOR GSoC 2020** + +### Social Platform Donut GSoC Ideas: + +{% page-ref page="role-management.md" %} + +{% page-ref page="tag-mechanism.md" %} + +{% page-ref page="github-bot.md" %} + +{% page-ref page="draft-proposal-functionality.md" %} + +{% page-ref page="draft-bot-for-donut-platform.md" %} + +### Codebadege GSoC Ideas: + +{% page-ref page="badge-and-point-allotment-api.md" %} + +{% page-ref page="issue-management-api.md" %} + +{% page-ref page="virtual-illustration-in-codebadge.md" %} + diff --git a/activities/gsoc2020/gsoc2020-ideas/badge-and-point-allotment-api.md b/activities/gsoc2020/gsoc2020-ideas/badge-and-point-allotment-api.md new file mode 100644 index 0000000..9538576 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/badge-and-point-allotment-api.md @@ -0,0 +1,42 @@ +# Badge and point allotment API inside Codebadge + +### Priority: + +High + +### Description: + +In Codebadge, presently all the badge allotment computation are taking place at browser level. We require to shift all the badge related computation at back-end using nodejs API. The task to be preformed under this task are:- + +* Designing a database schema to manage user points for projects and organization, storing badge templates in efficient manner, storing admin defined pattern for awarding badges and special badges. +* Design a badge allotment API which shall fulfill following criteria's:- + * Admin can decide the count of points for allotting points. + * Using Machine Learning allocating points as per past relocatable issues. + * Designing a special badge allotment system which can be decided by the admin while creating an account. +* Designing an API system which returns render-able badges. Badges must be saved in minified format which shall be improved in quality and size on rendering time. +* Creating shareable illustrator system which admin can only share with his organization contributors using email/github username. +* Fetching contribution outside browser without using crone jobs approach which makes the computation speed slower. + +{% hint style="warning" %} +**References:** [**Trello Webhooks**](https://developers.trello.com/page/webhooks) **,** [**Playing with Github Webhooks \| Github**](https://developer.github.com/webhooks/)\*\*\*\* +{% endhint %} + +### **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs +* experience of working sockets programming and using github apis +* Good Knowledge of Modules Bundling + +### Difficulty Level: + +Moderate + +### Expected Outcome: + +This project would result in the improvement in the badge alotment system of Codebadge project which will allow admin to judge the progress of the project in the better way. + +### Potential Mentors: + +[**Jaskirat Singh**](https://github.com/jaskirat2000) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren) + diff --git a/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/README.md b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/README.md new file mode 100644 index 0000000..d971172 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/README.md @@ -0,0 +1,2 @@ +# Codebadge Ideas + diff --git a/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/badge-and-point-allotment-api.md b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/badge-and-point-allotment-api.md new file mode 100644 index 0000000..e2bdfa8 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/badge-and-point-allotment-api.md @@ -0,0 +1,30 @@ +# Badge and point allotment Api + +Priority:- High + +\*\*\*\* + +## Summary + +In Codebadge, presently all the badge allotment computation are taking place at browser level. We require to shift all the badge related computation at backend using nodejs API. The task to be preformed under this task are:- + +* Designing a database schema to manage user points for projects and organization, storing badge templates in efficient manner, storing admin defined pattern for awarding badges and special badges. +* Design a badge allotment api which shall fulfill following criterias:- + * Admin can decide the count of points for alloting points. + * Using Machine Learning allocating points as per past relatable issues. + * Designing a special badge allotment system which can be decided by the admin while creating an account. +* Designing an api system which returns renderable badges. Badges must be saved in minified format which shall be improved in quality and size on rendering time. +* Creating shareable illustrator system which admin can only share with his organization contributors using email/github username. +* Fetching contribution outside browser without using cron jobs approach which makes the computation speed slower. + + **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs +* experience of working sockets programming and using github apis +* Good Knowledge of Modules Bundling + +#### Difficulty Level: Moderate + +#### Mentors + diff --git a/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/comment-management-api.md b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/comment-management-api.md new file mode 100644 index 0000000..bce450c --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/comment-management-api.md @@ -0,0 +1,25 @@ +# Comment Management API + +**Priority:- Moderate** + +### **Summary** + +* Creating a Webhook which fires when a comment is made on the issues/pull request. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* The comment must be analysed and decided how much the issue is relatable to the issue topic using machine learning. +* Reaction of other users shall award extra points for +ve comment and reduction in case of -ve comment/ reaction. +* Admin and maintainer +ve reactions and mentions must awarded with extra points. -ve reactions must be reflected in the same way. +* Comments must suggest the maintainer some contributor in case of issue. The person who has the most relatable comment must be suggested and shall be displayed on issue section. +* Inappropriate comments or language must be awarded a penalty. + +### **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using github apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making Restfull API services + +### **Difficulty Level: Moderate** + +### Mentor + diff --git a/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/issue-management-api.md b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/issue-management-api.md new file mode 100644 index 0000000..4370415 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/issue-management-api.md @@ -0,0 +1,29 @@ +# Issue Management API + +**Priority:- Moderate** + +### **Summary** + +In Codebadge, presently all the badge allotment computation are taking place on the basis of comment count. We want to create a smarter approach to give each user its token of appreciation. Moreover CRON jobs approach which is being followed at present is pretty slow and hence need to optimise it. Trello dashboard being an awesome tool to manage Issue and pull requests is something we would like to take into consideration as a platform to manage the tasks and issues. The task to be performed under this project are:- + +* Creating a Webhook which fires when a issue is made on the project. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* Admin dashboard interact with Trello to add a new card on related section by using classification algorithm of machine learning. +* Trello award points are set at issue card on trello which are awarded using badge and point allotment system. +* Issue award points must be visible on github issue section. +* Card must be moved or deleted respectively whenever needed on the basis of development. Awards must be updated in case of shift. +* Auto assigning issue on the basis of past issue solutions. +* Update database schema wherever required with an efficient schema design. +* Reward point updates in database for issue and updating badges on basis of points. + + **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using github apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making Restfull API services + +### **Difficulty Level: Moderate** + +#### **Mentors** + diff --git a/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/pull-request-manager-api.md b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/pull-request-manager-api.md new file mode 100644 index 0000000..75acc15 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/codebadge-project-ideas/pull-request-manager-api.md @@ -0,0 +1,30 @@ +# Pull Request manager API + +## \*\*\*\* + +**Priority:- High** + +### **Summary** + +In Codebadge, presently all the badge allotment computation are taking place on the basis of comment count. We want to create a smarter approach to give each user its token of appreciation. Moreover CRON jobs approach which is being followed at present is pretty slow and hence need to optimise it. Trello dashboard being an awesome tool to manage Issue and pull requests is something we would like to take into consideration as a platform to manage the tasks and issues. The task to be performed under this project are:- + +* Creating a Webhook which fires when a pull request is made on the project. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* Admin dashboard interact with Trello to check the award points if already set on trello cards. +* These awarded points must be updated in users section in the database. Remember maintainer’s merge commit shall not be awarded any point to the maintainer. +* If the trello dashboard has no such points in the card default points shall be awarded to the user which shall be decided by badge and point allotment api\(which is a separate project\). +* All the point updated that are made shall reflect in db. +* Update badges on the basis of total points +* Moving trello dashboard as per pull request merge usingv machine learning classification. +* Pull request award points must be visible for user on the respective pull request. +* Extra award points for an open issue. + +### **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using github apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making restful API services + +### **Difficulty Level: Moderate** + diff --git a/activities/gsoc2020/gsoc2020-ideas/donut-project-ideas.md b/activities/gsoc2020/gsoc2020-ideas/donut-project-ideas.md new file mode 100644 index 0000000..ad786d0 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/donut-project-ideas.md @@ -0,0 +1,2 @@ +# Donut Ideas + diff --git a/activities/gsoc2020/gsoc2020-ideas/draft-bot-for-donut-platform.md b/activities/gsoc2020/gsoc2020-ideas/draft-bot-for-donut-platform.md new file mode 100644 index 0000000..e3ee90f --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/draft-bot-for-donut-platform.md @@ -0,0 +1,54 @@ +# Personal Assistant for Donut Platform + +### Priority: + +High + +### Description: + +#### Tasks: + +* [ ] Build the UI of the bot. +* [ ] Bot should respond based on pre defined commands: + * [ ] Todo commands: + * [ ] View all items in todo + * [ ] Add an item to todo list + * [ ] Remove an item from todo + * [ ] Mark an item to done + +#### **Detailed Info:** + +This bot is to be built as an independent module which will be integrated into Donut platform. Making it as an independent module will help us make this available to anyone willing to integrate this bot into there website/platform. + +#### **Working:** + +Upon integrating this with Donut user should be able to use this bot upon clicking the bot icon on the lower right corner of the screen. + +Upon clicking on the icon the bot should present user the commands that user can use in order to get a task done. For the beginning we are going ahead with TODO functionality. So when the bot interface opens users should be able to see 4 commands that will be viewing all the todos, adding a new to the list, removing a todo, marking todo as done. Clicking on each one of them should preform the desired task. + +If deadline of a particular todo is approaching the bot window should open automatically and send user a message saying the deadline is today or tomorrow. + +tegrate Jitsi with Donut platform. + +{% hint style="warning" %} +**References:** [**Intercomm**](https://www.intercom.com/) **,** [**ToDo Bot - Working inside Telegram**](https://botostore.com/c/todobbot/#) **,** [**First Telegram Bot**](https://chatbotslife.com/your-first-telegram-bot-47ea6034d311) **** +{% endhint %} + +### **Required Skills/knowledge:** + +* Tech Stack MongoDB Rest API +* Working with Backend +* Nodejs, ES 6 am Reactjs + +### **Difficulty Level:** + +Hard + +### **Expected Outcome:** + +* This would end up becoming a bot which will be used inside the Donut platform and can be called as a assistant for the users. + +### **Potential Mentors:** + +[**Devesh Verma**](https://github.com/devesh-verma) **and** [**Lakshya Khera**](https://github.com/lakshyabatman)\*\*\*\* + diff --git a/activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md b/activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md new file mode 100644 index 0000000..6b998e8 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md @@ -0,0 +1,93 @@ +# Proposal Functionality\(Pledge a research project\) inside Donut + +### Priority: + +Medium + +### Description: + +#### **Summary:** + +This feature of Donut platform will enable individual developers to reach out to Open Source Organizations. Doing so will help developers and organizations in many different ways, lets see how developers can get benefit from this: + +* Consider an individual developer who is passionate about his/her project which he/she thinks is good enough and wants to showcase this project under any reputed organization. +* Consider a scenario where developer wants to reach out to a bigger crowd of developers seeking help in development or enhancement of the project. +* Or say someone has some crazy idea which he wants to propose under any Open Source Organization seeking help from them then this functionality will help the developer in such scenario. + +#### **Detailed Info:** + +#### Here are the User Facing Tasks: + +* [ ] Build a Proposal page in Donut platform. +* [ ] Proposal page should have a markdown editor. +* [ ] Build draft functionality. +* [ ] Upon Submission of proposal show proposal tracker. +* [ ] The proposal tracker page should have comment functionality. + +**Task 1: Build a proposal page in Donut platform:** +This will be a page inside Donut platform which user will be able to access using the navigation panel. This page has to be built using Reactjs. You can refer to the designs\[1\] to build the page. + +**Task 2: Embedding a markdown editor:** +On this page the developer will be able to draft his proposal which will be submitted to Open Source Organizations. To start with this you can either embed an editor or build an editor which is totally dependent on you. The editor should support markdown syntax. The developer should be able to upload photos, attach documents/presentation related to the proposal. + +**Task 3: Build draft and resume functionality for editor:** +While the user is drafting the proposal the proposal should keep getting saved on regular intervals so that is the user closes the browser window or because of any other reasons the user leaves the page his progress keeps getting saved in Donut. User should also have option to save the proposal as draft and when the user returns to the page user can resume the proposal. + +**Task 4: Build a proposal tracker:** +This feature will help the user track the progress of the proposal and as which stage is the proposal currently on. This will only be visible to the user once the proposal has been submitted. We will have 4 stages of the proposal: +Stage 1: Proposal Submitted +Stage 2: Under Review +Stage 3: More information required -> This will be an optional stage and will be seen of the organization requests for more information from the user regarding the project. If the organization accepts the proposal then the tacker will jump to stage 4. +Stage 4: Proposal accepted. + +![Sample Image for proposal tracker](../../../.gitbook/assets/assets_-lsv46f7uzuvdedvews0_-ltflz2mqkow25nhe1al_-ltfm3no_hb7me2lxeku_artboard-1.jpg) + +**Task 5: Providing comment functionality on proposal page:** +This functionality will be enabled only when the organization asks for more info regarding the proposal. To understand this more clearly think of a situation where in user has submitted a proposal for some FOSS organization. The organization after going through the proposal wants bit more info or wants to have more clarity on the idea then the tracked will show Stage: More information required. On this stage we need to have a comment functionality which will behave more like a thread where organization and user can interact and get thing more clear. + +### Organization facing tasks: + +* [ ] Send an email to admins of organization once a proposal has been submitted. +* [ ] Build feature where organization can access the proposal. +* [ ] Schedule a meeting with the user. + +**Task 1: Send email to admins as soon as a proposal is submitted:** +Admins of the organization should receive an email stating that a new proposal has been submitted and they go and have a check on the proposal. So you are supposed to build the email feature which will send email to the admins of the organizations. You also need to code the email template which will have dynamic data as per user. + +**Task 2: Build functionality for admin dashboard to see the submitted proposals:** +As the user submits the proposal the the admins of the organization should be able to see the submitted proposal. When admin clicks on one proposal it should open a new page in which the proposal will be displayed. On this new page the admin should also be able to select if they want to proceed with the proposal or not. +If Admin marks as more info required which is Stage 3 of the proposal tracker, in that case the admin should be able to add comments from the new page where the proposal opens up for review. Also, any comments added by the user should also be visible to admins on that page. +If admins feels the idea or project is good and wants to proceed with it then they can change the state of the proposal to accepted state. As soon as the proposal gets accepted the user should a congratulation email says the propsal has been accepted. + +**Task 3: Integrate Jitsi for video calls:** +To provide more flexibility in terms of interaction between admins and user. Admins can setup a meeting with the user. To provide this video call functionality you need to integrate Jitsi with Donut platform. + +{% hint style="warning" %} +**References:** [**Integration of Jitsi**](https://jitsi.org/) **,** [**Make a Pledge \| Open Collective**](https://opencollective.com/pledges/new)\*\*\*\* +{% endhint %} + +### **Required Skills/knowledge:** + +* Tech Stack Nodejs, Reactjs and MongoDB +* Working with AWS S3 + +### **Difficulty Level:** + +Hard + +### **Expected Outcome:** + +* The user should be able to draft the proposal. +* User can save the proposal as draft and resume it as later point of time. +* Upon submitting the user should see the proposal tracker screen. +* Admins should receive email when a new proposal is submitted. +* Admins should be able to see all the submitted proposal on admin dashboard. +* Proposal should open in new tab once user admin clicks on a particular proposal. +* Admin can add comments to the proposal. +* Admin can setup a meeting with the user using Jitsi. +* User should receive email once proposal gets accepted. + +### **Potential Mentors:** + +[**Devesh Verma**](https://github.com/devesh-verma) ****and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren)\*\*\*\* + diff --git a/activities/gsoc2020/gsoc2020-ideas/github-bot.md b/activities/gsoc2020/gsoc2020-ideas/github-bot.md new file mode 100644 index 0000000..5a87672 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/github-bot.md @@ -0,0 +1,68 @@ +# Displaying Github Activity Data in Donut Platform + +### Priority: + +High + +### Description: + +**Summary:** + +Build a GitHub bot which users can install from GitHub marketplace\[1\] and configure the bot on selected repositories / all repositories based on users choice. After successful installation, the bot should send details of activities happening in the repositories on which bot is configured. Here repository activities refer to actions done by any user. + +* Bot Functionalities: + * Issues\[open/close/comment/assign/unassigned/assigned Users\] + * pr\[open/close/comment/review\] + * Share Issue on Donut as a post + * Reply to comments through Donut platform +* While enabling the bot + * Send a request to admin + * Then select repositories to enable the bot + +#### Detailed Info: + +**TASK 1:** The main purpose of this bot is to show github activity inside Donut platform. This feature will help users stay updated with all types of activities happening in the repository on which the bot has been configured. ****Donut platform will have a dedicated page to show github activities which users can access after logging in where they will able to see every activity that happens on github repos. + +**Github activities to be sent to Donut platform:** + +* Actions performed on issues: + * Issue created + * Issue closed + * Comment on an issue +* Actions performed on pull requests: + * Pull request opened + * Pull request closed + * Comment on a pull request + +**TASK 2:** Build a dedicated page for github activity as shown in the design. Activity data received should be stored in database and then displayed on the page. + +**TASK 3:** Build sharing functionality, such that every activity which is displayed on the activity page, user should be able to share any activity as a post. + +{% hint style="warning" %} +**References:** [**Github Market Place, Demonstrating expectations from the bot**](https://github.com/marketplace) **,** [**Probot**](https://probot.github.io/)\*\*\*\* +{% endhint %} + +The bot will be sending activity data to donut platform where the activities will be displayed + +### **Required Skills/knowledge:** + +* Tech Stack Nodejs, Reactjs and MongoDB +* Good knowledge of databases +* Good knowledge of Back-end +* Prior knowledge of UI/UX + +### **Difficulty Level:** + +Moderate + +### **Expected Outcome:** + +* The user should be able to install this bot on repositories they wish to. +* The bot should send activity data\(mentioned in Detailed info section\) to donut platform. +* Display the received data in proper format as show in the design. +* User should be able to share any activity as a post. + +### **Potential Mentors:** + +[**Jaskirat Singh**](https://github.com/jaskirat2000) and [**Devesh Verma**](https://github.com/devesh-verma) + diff --git a/activities/gsoc2020/gsoc2020-ideas/issue-management-api.md b/activities/gsoc2020/gsoc2020-ideas/issue-management-api.md new file mode 100644 index 0000000..0e87b07 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/issue-management-api.md @@ -0,0 +1,68 @@ +# Issues, Pull request and Comment Management API inside Codebadge + +### **Priority:** + +High + +### **Description:** + +**This project includes 3 parts as described below:** + +**ISSUE MANAGEMENT API SYSTEM** + +In Codebadge, presently all the badge allotment computation are taking place on the basis of comment count. We want to create a smarter approach to give each user its token of appreciation. Moreover CRON jobs approach which is being followed at present is pretty slow and hence need to optimist it. Trello dashboard being an awesome tool to manage Issue and pull requests is something we would like to take into consideration as a platform to manage the tasks and issues. The task to be performed under this project are:- + +* Creating a Webhook which fires when a issue is made on the project. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* Admin dashboard interact with Trello to add a new card on related section by using classification algorithm of machine learning. +* Trello award points are set at issue card on trello which are awarded using badge and point allotment system. +* Issue award points must be visible on github issue section. +* Card must be moved or deleted respectively whenever needed on the basis of development. Awards must be updated in case of shift. +* Auto assigning issue on the basis of past issue solutions. +* Update database schema wherever required with an efficient schema design. +* Reward point updates in database for issue and updating badges on basis of points. + +**COMMENT MANAGEMENT API SYSTEM** + +* Creating a Webhook which fires when a comment is made on the issues/pull request. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* The comment must be analysed and decided how much the issue is relocatable to the issue topic using machine learning. +* Reaction of other users shall award extra points for positive comment and reduction in case of negative comment/ reaction. +* Admin and maintainer positive reactions and mentions must awarded with extra points. positive reactions must be reflected in the same way. +* Comments must suggest the maintainer some contributor in case of issue. The person who has the most relocatable comment must be suggested and shall be displayed on issue section. +* Inappropriate comments or language must be awarded a penalty. + +**PULL REQUEST MANAGER API SYSTEM** + +* Creating a Webhook which fires when a pull request is made on the project. This webhook link shall be provided to the admin at the time of adding an organization to his/her dashboard. +* Admin dashboard interact with Trello to check the award points if already set on trello cards. +* These awarded points must be updated in users section in the database. Remember maintainer’s merge commit shall not be awarded any point to the maintainer. +* If the trello dashboard has no such points in the card default points shall be awarded to the user which shall be decided by badge and point allotment api\(which is a separate project\). +* All the point updated that are made shall reflect in db. +* Update badges on the basis of total points +* Moving trello dashboard as per pull request merge usingv machine learning classification. +* Pull request award points must be visible for user on the respective pull request. +* Extra award points for an open issue. + +{% hint style="warning" %} +**References:** [**Text similarity using Corpus**](https://www.site.uottawa.ca/~diana/publications/tkdd.pdf) **,** [**Trello Webhooks**](https://developers.trello.com/page/webhooks) +{% endhint %} + +### **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs, python for machine learning +* experience of using GitHub apis +* Good Knowledge of Modules Bundling +* Good Knowledge of making Restful API services + +### **Difficulty Level:** + +Moderate + +### Expected Outcome: + +This project would result in the improvement in the badge allotment system of Codebadge project by evaluating the quality of issue which will allow admin to judge the progress of the project in the better way. + +### Potential Mentors:- + +[**Jaskirat Singh**](https://github.com/jaskirat2000) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren) + diff --git a/activities/gsoc2020/gsoc2020-ideas/role-management.md b/activities/gsoc2020/gsoc2020-ideas/role-management.md new file mode 100644 index 0000000..540ba5a --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/role-management.md @@ -0,0 +1,56 @@ +# Development of Admin Management mechanism for DONUT + +### **Priority:** + +High + +### **Description:** + + [**Donut Platform**](https://github.com/codeuino/Social-Platform-Donut) is a flexible open source **Social Network Kit that aims** to give you the customized social network, social intranet or huge social enterprise application for communities that really fits their needs. + +Development of configuration mechanism is one of our newest additions to our installation frameworks of Donut Platform. Currently Donut is central hosted but aims to get bundled as FOSS/OSS tool. So, the task of this major project is to develop an **Admin Management System** that will allow individuals or community admins to setup for themselves. To simplify the configuration, these predefined modules will have the most common use cases with different options for modules and settings while setting up this environment.Few have been described below which would serve essential features as a separate modules: + +1. Development of module for Configuration screens : + +* **Screen 1:** Registering Admin account with information such as Admin name, Email, Username, Password, etc. For example check [**here**](https://www.tecmint.com/wp-content/uploads/2018/05/Create-New-Discourse-Account.png) +* **Screen 2:** Include Admin Account Confirmation through email. An email send to the Admin account, On confirmation should redirect them to the page of "Activate Account" which further leads to other setup. +* **Screen 3:** Welcoming Screen, that should allow to setup Community account. For hint check [**here**](https://support.patreon.com/hc/article_attachments/360027026912/Image_2019-04-24_at_9.25.35_AM.png) +* **Screen 4:** Setting up Community profile and permissions like Community Name, Description,Welcoming Invites, Access \( Is community open to everyone or limited to invites,etc. \), Automated Invites, System Email setup, etc. +* **Screen 5:** This screen includes **View** are from User end that how the Admins want their platform to look like. This will have custom things like Theme Selection, Community Top bar \( Including Logos\), home page look, some other modules. **\(Important Part !\)** +* **Screen 6:** Includes the Thumbnail or the preview of the main page based upon the settings configured by Admin. + +2. Development of Admin panel : + +* Admins can add members to the community through Invites, also can invite other as an Admin/moderator due which all the same rights will be shared with the other person. +* Blocking users \( Giving access to block people\) +* Analytical representation \(This will help community Admins view stat for their posts, members joined, etc\) +* Giving Access to delete any post/comments,etc +* Giving them access to change modules in between any time through toggle or any other available options such as Theme change, Removing/Adding any other modules, +* Making a feature of "**Maintenance**". with this no user should be able to login/signup . they should see a particular page of maintenance. these rights should be given to only admins. +* Allowing to give them access for the "settings" of the community +* Activity logs \( This feature will describe about followings, comments, Upvote/Downvote, stare, pinned things\( posts/projects/events/etc\) on their dashboard. + +{% hint style="warning" %} +**References:** [**Youtube Guide of Discourse SetUp**](https://www.youtube.com/watch?v=sjFlBgSiyCY) **,** [**How to bundle a software \| Tom's Guide**](https://forums.tomsguide.com/threads/how-to-bundle-software-in-one-installer.310629/) **,** [**Admin panel Templates**](https://colorlib.com/wp/admin-panel-templates/) +{% endhint %} + +### **Required Skills/knowledge:** + +* Good knowledge of databases +* languages such as NodeJs, JavaScript, React; +* Knowledge of visual representation +* Good Knowledge of Modules Bundling +* UI/UX experience is also required with unique approach. + +### **Difficulty Level:** + +Moderate + +### **Expected Outcome:** + +This project would result in formation of packaged setup of a Donut platform along side with Admin panel with new User Interface that would allow the Admins/Moderators to use it in their custom way. + +### **Potential Mentors:** + + [**Jaskirat Singh**](https://github.com/jaskirat2000) , [**Devesh Verma** ](https://github.com/devesh-verma) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren) + diff --git a/activities/gsoc2020/gsoc2020-ideas/tag-mechanism.md b/activities/gsoc2020/gsoc2020-ideas/tag-mechanism.md new file mode 100644 index 0000000..35d75eb --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/tag-mechanism.md @@ -0,0 +1,58 @@ +# Developing a module with a Tag Cloud and a post check mechanism + +### **Priority:** + +Medium + +### **Description:** + + The [**DONUT Platform**](https://github.com/codeuino/Social-Platform-Donut) contains the notification feature which helps users to accommodate things in easy way. So the task of this project is to develop a mechanism for **"tags" \(**[**Explanation of tags in posts by WordPress**](https://en.support.wordpress.com/posts/tags/)**\)** as an independent "**Tags Cloud**"and check and sort out similar posts from user end. These tags will provide a useful way to post users related to quickly tell readers what a post is about and where to redirect or highlight the particular post more. The mechanism should be developed in such a way that users can make their own tags or can also select from predefined tags\(this needs to be built as a kind of panel/store\) which gets automatically saved at one place and can be called as tag cloud and while submitting any posts it should get redirected to the appropriate users/groups which contains the similar tags. The tag cloud needs to be built which can store all the tags. When someone viewing your blog/project/article/any other post, clicks on one of defined Tag links, a Tag archive page with all the posts belonging to that Tag, should be displayed. + +Other part of this project is develop a "**Post Check**" mechanism which will help the user writing the post to check from similar posts and allow to do some actions on the similar post. + +**Tag prediction: -** In addition of the above idea, it is possible to predict the tags based on the content of the articles/posts using some ML algorithms \(Supervised Learning\). So that when user creates the post/article then he/she will have some auto-predicted tags as a suggestion along with option of adding custom tags. + +**Approach:-** Firstly pre-process the data \(i.e posts/articles content\) and accordingly train the ML model and after that use the classifications algorithms to predict the tags. + +**Understand tag-prediction with an example:** + +Suppose a user has created the article/post whose content is something like this: + +**"**GSOC stands for Google Summer of Code, a 3 to 4-month long program for students studying in any university all across the globe. Google started this program long back in 2005 aiming to promote the open source culture among the college and university students. During this program, a student works with an open source community or organization of his/her choice for around 3 to 4 months on a project.**"** + +So for the above post the predicted tag should be like: "**GSOC**", "**Open Source**", "**Google**" and it should be displayed in the **Add tag field**, so if it seems irrelevant to the user then he can remove that and add their custom tag. \( Something like this: [click](https://raw.githubusercontent.com/olahol/react-tagsinput/HEAD/example/demo.gif) \) + +**Lets understands this with an example** + +**PART 1:** Assume that **"X"** user signs up on the DONUT platform. Once the **"X"** user has defined all the details about himself, then he would be asked to select some tags from the tags cloud which describes him the best and here, **"X"** user chooses "Designer", "Nodejs" and "Html". this tells us from the description of the tags in the tags cloud that this **"X"** user is a "Designer" and knows languages like "Nodejs" and "Html". On pursuing further these tags get stored for him. + +Now assume other user **"Y"**, suppose "Y" user is already logged into this platform. **"Y"** user writes a post as project/article/blog or any other thing related to feeds on it, before **he/she** publishes, he would be asked to choose some tags from the "Tags Cloud". Suppose the **"Y"** user choose "Nodejs" tag from it. **Here, we see that user "X" and "Y" has "Nodejs" common in them.** So on publishing the post by user **"Y"**, the particular project would be redirected to the **"X"**\(because they both contain common tags\), According to the tags description user **"X"** would be able to review the thing. + +PART 2: Suppose that **"X"** user writes some post, so before publishing it. He would be shown similar posts that either matches with the **"Title"** or **"Post Content"**. So clicking on any, he would be able to "Add/comment/share/Add reasons". This will help avoid replication of content as well. + +{% hint style="warning" %} +**References:** [**Tag module by WordPress**](https://en.support.wordpress.com/posts/tags/) **,** [**Tag Screens by WordPress**](https://en.support.wordpress.com/posts/tags/) +{% endhint %} + +### **Required Skills/knowledge:** + +* Good knowledge of databases +* Good Knowledge of Back-end +* languages such as NodeJs, JavaScript, React; +* For tag-prediction: Python, ML, Supervised learning \(Beginners - Intermediate\) +* Knowledge of front-end as well for developing a tag dashboard + +### **Difficulty Level:** + +Moderate + +### **Expected Outcome:** + +This project would result in development of a tag mechanism with an appropriate dashboard where one can "Create/Edit/Manage/Delete" with proper settings option. + +### **Potential Mentors:** + +[**Jaskirat Singh**](https://github.com/jaskirat2000) , [**Devesh Verma** ](https://github.com/devesh-verma) and [**Vaibhav D. Aren** ](https://github.com/vaibhavdaren) + + + diff --git a/activities/gsoc2020/gsoc2020-ideas/virtual-illustration-in-codebadge.md b/activities/gsoc2020/gsoc2020-ideas/virtual-illustration-in-codebadge.md new file mode 100644 index 0000000..2875ba9 --- /dev/null +++ b/activities/gsoc2020/gsoc2020-ideas/virtual-illustration-in-codebadge.md @@ -0,0 +1,52 @@ +# Virtual Illustration in Codebadge + +### Priority: + +High + +### Description: + +Codeuino is an open source social networking organisation that tends to work for building social environments for communities, allowing them to use in their custom way. Codebadge stands out as one of the community run project which aims to support contributors with badges and allowing Community admins/moderators to use it in their custom way for every contributor involved through their contribution in the organizations. We are developing a FOSS tool that allows ones to create badges and integrate them with their forums which is based on github commits. It has got more enhanced features which allow them with analytics, drafting, allotment and many more. + +We are designing admin dashboard through which he/she can set the criterias for badge allotment, and analyse the project progress and allot issues on the basis of past contributions. We are also willing to enhance our Codebadge illustrator by adding new functionalities. + +### Task and Features + +This project includes working on various tasks such as development of Organisation Admin dashboard and UI builder \(Illustrator\) + +**1. Organisation Admin's panel:-** + +* Search by username, his contributions in the community. +* Searching on the basis of project all contributors on the basis of project. +* Displaying analytics such as charts of progress of each projects and other related things. +* Displaying chart of contributions by an organization member. +* Displaying tech stack and issue type he has contributed to\(such as designing,enhancement, bug solving\) +* Suggesting issues assignment to contributor on the basis of past experience.\(7-8 days\) + +**2. Illustrator:-** This tool involves visual editor or we could say visual UI builder with just drag and drop inside the dashboard. + +* Displaying image on html canvas. +* Move tool with js. +* Resize image on drag with js. +* Quick Selection tool using js and Python. +* Puppet wrap using js and Python. +* Layers using js and Flask. +* Pick tool using Python. +* Pen tool using js + +### Required Skill/Knowledge: + +Students shall have knowledge of:- Creating and Working with github APIs Creating restful apis in flask api for illustrator for machine learning features. Html canvas, vuejs, css, javascript for ui designing. + +### **Difficulty Level:** + +Moderate + +### Expected Outcome: + +Codebadge will gain a new look with features of Admin panel and Illustration tools + +### Potential Mentors:- + +[**Jaskirat Singh**](https://github.com/jaskirat2000) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren) + diff --git a/activities/linux-foundation-communitybridge-mentorship-program-codeuino-mentorship.md b/activities/linux-foundation-communitybridge-mentorship-program-codeuino-mentorship.md new file mode 100644 index 0000000..f874655 --- /dev/null +++ b/activities/linux-foundation-communitybridge-mentorship-program-codeuino-mentorship.md @@ -0,0 +1,125 @@ +--- +description: >- + This page contains the details of how to participate with "Codeuino + Mentorship" Program +--- + +# Linux Foundation CommunityBridge Mentorship Program - Codeuino Mentorship + +### CommunityBridge by The Linux Foundation + +[**Community Bridge**](https://communitybridge.org/) is a platform developed by **The Linux Foundation**, which accelerates the adoption, innovation, and sustainability of open-source software. + +Community Bridge is actively used by the Codeuino as a mentorship platform across its projects and can be found with the name "[**Codeuino Mentorship**](https://people.communitybridge.org/project/7deb8e48-6797-4115-bb96-9cf4ccee022e)" on the CommunityBridge Platform. + +### **Codeuino Mentorship** + +**Codeuino Mentorship** is a 3 months program, run under The Linux Foundation CommunityBridge platform for various "**terms**" in a year. + +This program is designed to help developers with the necessary skills - experiment, learn, and contribute effectively to open source communities, which can initially seem overwhelmingly vast. + +{% hint style="info" %} +"**Terms**" here means a different time period. For example, currently, we have for Summer2020. It can be Fall, Winter, or Spring time period and these different time periods reflect as "terms". Any name can be given to terms. +{% endhint %} + +Following are the core goals of the Mentorship Program: + +* Help mentees learn and enhance their technical skills, and inspire them to become long-term active contributors. +* Teach aspiring developers the open-source culture and collaboration norms, and guide them to participate in the open-source community more effectively by using collaboration tools and infrastructure. +* Strengthen projects and the communities that are crucial to the Linux ecosystem by improving security and quality of releases. +* Provide a skilled and diverse talent pool of prospective employees trained by experts to companies in the ecosystem of related technology. +* Add well-trained and educated diverse talent to projects, and inspire them to write code for open-source software products for the benefit of the entire community and users. + +{% hint style="info" %} +**NOTE:** For more details please refer to the [**official documentation website of The Linux Foundation CommunityBridge Platform**](https://docs.linuxfoundation.org/docs/communitybridge/communitybridge-mentorship)\*\*\*\* +{% endhint %} + +### Submitting your Application + +{% hint style="success" %} +**NOTE:** **In order to apply to the "Codeuino Mentorship" program you should** [**submit your application on this portal**](https://people.communitybridge.org/project/7deb8e48-6797-4115-bb96-9cf4ccee022e)\*\*\*\* +{% endhint %} + +{% hint style="info" %} +**NOTE: Just to let you know that for Term Summer 2020, we just planned to accept only 2 mentees under the Codeuino Mentorship program.** +{% endhint %} + +### Eligibility Rules for Mentees + +The following eligibility rules apply to program applicants. You must: + +* Be at least 18 years of age +* Currently involved with a university +* Be eligible to work in the country and jurisdiction where you will be participating in the Mentorship program +* Not reside in a country or jurisdiction where participation in the mentorship is prohibited under applicable U.S. federal, state or local laws or the laws of other countries +* Not actively participating in another CommunityBridge mentorship program. +* Be seeking to participate on your own behalf as an individual +* Not be subject to any existing obligations to third parties \(such as contractual obligations to an employer\) that would restrict or prohibit your participation in the Mentorship program + +### Program Structure for "Term: Summer 2020" + +The CommunityBridge Mentorship program is a 12-week full-time program. There will be a time period for prerequisite tasks completion, skill evaluation, review, and selection process prior to the starting of actual training. + +| Time Period | Purpose | +| :---: | :---: | +| **July 1, 2020 - July 15, 2020** | Mentees submit applications | +| **July 25, 2020** | Mentees are announced | +| **August 1, 2020** | The official coding period starts | +| **October 31, 2020** | Coding period ends | + +### Phase-by-Phase Process + +1. **Reviewing Submitted Application:** After you submit your application, and apply to project\(s\), it takes a minimum of two weeks of time to evaluate your application. You are advised to complete the prerequisite tasks during this time period failing which your application will not be considered for the mentorship program. You can check your application status by navigating to your Linux Foundation account. +2. **Mentee Contract:** If you are selected for the mentorship program, you will be contacted through email or phone, and you will have to undergo contract and HR processes. +3. **Mentee Working:** This is the time when you actually learn and contribute to the community. During this period, you are expected to dedicate your quality time, and work with your mentor in structuring a project planning, understanding open-source culture, development tooling and infrastructure, making steady progress towards completing objectives, milestones, and tasks as defined in the project plan, and actively contribute to the community to successfully complete the course. You can start by making small contributions to the projects. You are highly encouraged to contribute to documentation. +4. **Evaluation:** You will be evaluated on a periodic basis by your mentors. The reason behind this is to get feedback from your mentor about your progress and to check if you are completing your objectives and milestones as per the project planning, and are actively participating in community discussions, and so on. **Note:** Depending on the project, there will be three or four evaluations during the entire program. Based on your evaluation report, the stipend will be released. +5. **Stipend:** Payments happen after completion of each evaluation time. Stipends are released if your evaluation report shows satisfactory progress of your mentorship training. The total stipend amount is paid phase-wise after each evaluation, and the stipend amount for each evaluation varies from project to project. +6. **Letter of Completion:** If you successfully finish the program by completing all your project milestones, deliverables, and assigned tasks, which may include an exam, you will also be asked to write and publish a blog to receive a digital Letter of Completion at the end of the program. Hurray! You graduated. **Note:** Get in touch with your Program Manager or Mentor to help you with writing and publishing a blog. + +### What is the Mentorship Stipend? + +A stipend is a periodic payment for your participation as a mentee in the Mentorship program. A stipend and other incentives support and encourage mentees to participate. Funding for stipends and other perks is determined solely by each project. After you complete the prerequisite qualifications and are accepted to the program, you become eligible to receive a stipend. + +**How much stipend amount will I receive?** + +Stipend [**amounts**](https://docs.linuxfoundation.org/docs/communitybridge/communitybridge-mentorship/mentee-stipends/total-stipend-amount) are calculated based on your location. + +**How is my location determined?** + +Your location is determined by where you currently reside, that is the country of current residence. If you are enrolled at an online institution or are a recent graduate, your stipend is determined by the location of your permanent residence. + +**How are the stipend amounts determined?** + +We are using a Purchasing Power Parity \(PPP\) based calculation to determine the stipend. We start with a base amount of 6000 USD and then adjust it based on each country's PPP value. There is a minimum \(3000 USD\) and maximum \(6600 USD\) stipend amount. The base amount takes into consideration the fact that many universities are in urban centers which can be more expensive than other parts of the country. + +**What is Purchasing Power Parity? \(PPP\)** + +Purchasing Power Parity is a way to estimate the exchange rate between two currencies to determine equivalent purchasing power. For details, refer the following links: + +* [**Wikipedia: Purchasing Power Parity**](https://en.wikipedia.org/wiki/Purchasing_power_parity)\*\*\*\* +* [**World Bank: What is Purchasing Power Parity?**](http://pubdocs.worldbank.org/en/332341517441011666/PPP-brochure-2017-webformat-rev.pdf)\*\*\*\* + +### Codeuino Mentorship Program Coordinators + +#### Program Administrator + +* **Jaskirat Singh** + +**Project mentors** + +* **Devesh Verma** +* **Vaibhav Aren** +* **Siddharth Simharaju** + +{% hint style="info" %} +**Feel free to join Codeuino's communication channel at** [**slack.codeuino.org**](https://slack.codeuino.org) **for any queries and discussions.** +{% endhint %} + +{% hint style="warning" %} +**Do not forget to read** [**Mentees Guide by The Linux Foundation**](https://docs.linuxfoundation.org/docs/communitybridge/communitybridge-mentorship/mentee-guide)\*\*\*\* +{% endhint %} + +{% hint style="success" %} +Citing the source of this documentation:[ **CommunityBridge Documentation by The Linux Foundation**](https://docs.linuxfoundation.org/docs/communitybridge)\*\*\*\* +{% endhint %} + diff --git a/activities/rails-girls-summer-of-code-2020.md b/activities/rails-girls-summer-of-code-2020.md new file mode 100644 index 0000000..eafc9f7 --- /dev/null +++ b/activities/rails-girls-summer-of-code-2020.md @@ -0,0 +1,191 @@ +# Rails Girls Summer of Code 2020 + +## Welcome to Rails Girls Summer of Code with Codeuino + +**Rails Girls Summer of Code** is an [award-winning](https://railsgirlssummerofcode.org/blog/2016-06-01-ruby-heroes-2016) global fellowship program aimed at bringing more diversity into Open Source. It welcomes all women and non-binary applicants who want to gain a footing in the world of coding and further expand their knowledge and skills. The focus is on advanced-beginners who want to enter programming full-time. + +As a fellowship program, successful applicants are paid a monthly stipend, from July to September. This breaks down all-too-common financial barriers, allowing students to work on a worthwhile Open Source project. + +Working in two-person teams, students are supported by a mentor directly involved with the Open Source project, and independent coaches with extensive developer experience. + +To learn more about this year's event and how RGSoC works, please refer to the [**Rails Girls Summer of Code Guide**](https://railsgirlssummerofcode.org/students/application/)\*\*\*\* + +**We are glad to apply to Rails Girls Summer of Code 2020 as a mentoring organisation, where we gonna have separate projects listed by potential mentors in** [**RGSOC App**](https://teams.railsgirlssummerofcode.org/projects)**. In the meanwhile feel free to move around and connect with the community.** + +## **Get in Touch with us** + +The projects under renowned organisation gets listed separtely on the [**RGSoC Project App**](https://teams.railsgirlssummerofcode.org/projects)**. People who wants to mentor project pickups from the project Ideas page and list them up on the RGSOC website as an independent project.** + +The Organisation administrators for RGSoC 2020 are [Jaskirat Singh](https://twitter.com/jaskirat626) followed by co-organisation administrator Ayush + +* **Email:** Ayush and Jaskirat + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **SLACK Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org) +* **Contact Email:** [rgsoc@codeuino.org ](mailto:rgsoc@codeuino.org) + +## **Involving as a Student under Codeuino** + +**Create your application at** [**https://teams.railsgirlssummerofcode.org/apply**](https://teams.railsgirlssummerofcode.org/apply) + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the RGSoC application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [Get Involved Guide](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our [SLACK](http://codeuino.slack.com) channel. Here is the [link to join the communication channel](http://slack.codeuino.org). +5. **Introduce yourself** within the community. +6. Run, Test and identity some potential issues in [Codeuino Github Repositories](https://github.com/codeuino) +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about RGSoC** by understanding it and reading about it on their [Manual](https://railsgirlssummerofcode.org/students/application/) + +#### **NOTE: Students can also propose their own ideas that they want to include within the community** + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including RGSoC. If you don't have a blog yet, you should create one. **You will be required to write a blog post every week about your planning work and project progress during RGSoC. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#RGSOC channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of RGSOC + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your RGSoC project, and for other topics that interest you. +4. **Present your project in events, Conferemnces and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. The person who is willing to mentor takes up the project within the community and propose it under RGSOC on the basis of involvement and prior knowledge of it. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +**Consider proposing your own ideas as well that match the community project style**. + +Make sure you get through the **"**[**Mentor Guide**](https://railsgirlssummerofcode.org/guide/projects/)**"** + +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Summer of Code organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + +## Project Ideas + +### IDEA 1 + +### Project description + +Codeuino is an open source social networking organisation that tends to work for building social environments for communities, allowing them to use in their custom way. Codebadge stands out as one of the community run project which aims to support contributors with badges and allowing Community admins/moderators to use it in their custom way for every contributor involved through their contribution in the organizations. We are developing a FOSS tool that allows ones to create badges and integrate them with their forums which is based on github commits. It has got more enhanced features which allow them with analytics, drafting, allotment and many more. + +We are designing admin dashboard through which he/she can set the criterias for badge allotment, and analyse the project progress and allot issues on the basis of past contributions. We are also willing to enhance our Codebadge illustrator by adding new functionalities. + +The coaches who will be helping you out remotely are:- + +* [Jaskirat Singh](https://github.com/jaskirat2000) +* [Ayush Nagar](https://github.com/ayushnagar123) + +### Project's Requirements + +Students shall have knowledge of:- Creating and Working with github APIs Creating restful apis in flask api for illustrator for machine learning features. Html canvas, vuejs, css, javascript for ui designing. + +### Task and Features + +This project includes working on various tasks such as development of Organisation Admin dashboard and UI builder \(Illustrator\) + +**1. Organisation Admin's panel:-** + +* Search by username, his contributions in the community. +* Searching on the basis of project all contributors on the basis of project. +* Displaying analytics such as charts of progress of each projects and other related things. +* Displaying chart of contributions by an organization member. +* Displaying tech stack and issue type he has contributed to\(such as designing,enhancement, bug solving\) +* Suggesting issues assignment to contributor on the basis of past experience.\(7-8 days\) + +**2. Illustrator:-** This tool involves visual editor or we could say visual UI builder with just drag and drop inside the dashboard. + +* Displaying image on html canvas. +* Move tool with js. +* Resize image on drag with js. +* Quick Selection tool using js and Python. +* Puppet wrap using js and Python. +* Layers using js and Flask. +* Pick tool using Python. +* Pen tool using js + +### IDEA 2 + +### Project Description + +Codeuino is an open source social networking organisation that tends to work for building social environments for communities, allowing them to use in their custom way. "**Season of Design**" is one of the new initiative by Codeuino which tends to focus more on diverse tech designers. The goal of Season of Design is to provide a platform for designers and Open source organizations to collaborate and work to improve the design of their open source projects. Since not many designers are a part of the open-source community, we want to bridge the gap between them and let them gain experience in contributing to open source communities. For designers who are a part of open source communities, it provides them a way to collaborate with other designers and find ways to work more effectively. + +So taking this into consideration this project idea will aim to build a "**Management System**" for **Organizers**, **Org Admins/Mentors** and **Mentees** separately for the above idea where they could collaborate easily and efficiently. + +### Project Requirements + +The ideal students who would be working on this project needs to have a good knowledge of web development. React, Java script and any other front-end framework a student is comfortable to deliver same results is welcomed. Prior knowledge of working with databases Nodejs, mongo/angular would be an important addition alongside with understanding of UI/UX. + +### Tasks and Features + +This project would be developed in 3 separate sections. Please find the details of requirements needed in these three sections below: + +**PART 1- For Organizers:** Organizers are the ones who would be conducting/hosting this program keeping this into mind that organizers change with seasons. So for organizers student would be required to make a dashboard where they can track all the activities of a org mentor and mentees. + +* Organisers would be able to have control over the whole setup where they can change things in between or launch up initially. +* Organisers can add members to the community through Invites, also can invite other as an Admin/moderator due which all the same rights will be shared with the other person. +* Blocking users \( Giving access to block people\), Removing people from the contest whenever needed. +* Analytical representation \(This will help organizers know about stat for their posts, members joined, etc\) +* Giving Access to delete/remove any thing which is visible to mentors and mentees such as comments,etc +* Giving them access to change modules in between any time through toggle or any other available options such as Theme change, Removing/Adding any other modules, +* Making a feature of "**Maintenance**". with this no user should be able to login/signup . they should see a particular page of maintenance. these rights should be given to only admins. +* Allowing to give them access for the "settings" of the community +* Giving them access to "Open/Close" signups and logins for the communities. +* Making the screens to draft announcements which will be visible to the admins, mentors and mentees. +* Allowing project submission forms. +* Way of evaluating Admins/Mentors and Mentees. + + **PART 2 - For Admins:** Admins would be the ones who would be drafting an application for their project/community in this program and will work collectively with mentors and mentees just like GSoC. + +Development of module for Configuration screens : + +* **Screen 1:** Registering Admin account with information such as Admin name, Email, Username, Password, etc. For example check [**here**](https://www.tecmint.com/wp-content/uploads/2018/05/Create-New-Discourse-Account.png) +* **Screen 2:** Include Admin Account Confirmation through email. An email send to the Admin account, On confirmation should redirect them to the page of "Activate Account" which further leads to other setup. +* **Screen 3:** Welcoming Screen, that should allow to setup Community account. For hint check [**here**](https://support.patreon.com/hc/article_attachments/360027026912/Image_2019-04-24_at_9.25.35_AM.png) **and filling project details.** +* **Screen 4:** Setting up Community profile and permissions like Community Name, Description,Welcoming Invites, Access \( Is community open to everyone or limited to invites,etc. \), Automated Invites, System Email setup, etc. +* They will have dedicate pages for submitting their projects, inviting mentors and keeping a track with stats. +* They would be able to communicate with Organizers, Mentors and Mentees. +* If one Admin invites some other user as Admin then they should have a mechanism to share their dashboards. +* They can invite mentors to their project through forms and emails which should be drafted within this platform. +* Way of evaluating Mentors and Mentees. + +**Mentors will also have a same kinda dashboard** + +**PART 3 - For Mentees: Mentees \(here designers\) would be the ones who would be working on projects, drafting UI/UX of the projects. mentees needs to have a dashboard for themselves.** + +* Mechanism for mentees to register themselves through profile set up +* Choose projects which will be visible on their dashboard and select +* Integration of wiki or kinda doc which they would be using to submit their project proposal to mentors +* Way to communicate with others through comments +* Visual analytics which will help them to view their progress +* Way to submit their work and asking mentors to evaluate. + +\*\*\*\* + + + + + + diff --git a/activities/rails-girls-summer-of-code.md b/activities/rails-girls-summer-of-code.md new file mode 100644 index 0000000..3e6b4b9 --- /dev/null +++ b/activities/rails-girls-summer-of-code.md @@ -0,0 +1,126 @@ +# Rails Girls Summer of Code + +## Welcome to Rails Girls Summer of Code with Codeuino + +**Rails Girls Summer of Code** is an [award-winning](https://railsgirlssummerofcode.org/blog/2016-06-01-ruby-heroes-2016) global fellowship program aimed at bringing more diversity into Open Source. It welcomes all women and non-binary applicants who want to gain a footing in the world of coding and further expand their knowledge and skills. The focus is on advanced-beginners who want to enter programming full-time. + +As a fellowship program, successful applicants are paid a monthly stipend, from July to September. This breaks down all-too-common financial barriers, allowing students to work on a worthwhile Open Source project. + +Working in two-person teams, students are supported by a mentor directly involved with the Open Source project, and independent coaches with extensive developer experience. + +To learn more about this year's event and how RGSoC works, please refer to the [**Rails Girls Summer of Code Guide**](https://railsgirlssummerofcode.org/students/application/)\*\*\*\* + +**We are glad to apply to Rails Girls Summer of Code 2020 as a mentoring organisation, where we gonna have separate projects listed by potential mentors in** [**RGSOC App**](https://teams.railsgirlssummerofcode.org/projects)**. In the meanwhile feel free to move around and connect with the community.** + +## **Get in Touch with us** + +The projects under renowned organisation gets listed separtely on the [**RGSoC Project App**](https://teams.railsgirlssummerofcode.org/projects)**. People who wants to mentor project pickups from the project Ideas page and list them up on the RGSOC website as an independent project.** + +The Organisation administrators for RGSoC 2020 are [Jaskirat Singh](https://twitter.com/jaskirat626) followed by co-organisation administrator Ayush + +* **Email:** Ayush and Jaskirat + + Students and Mentors can join these discussion portals in order to carry discussions about their projects and interaction within community. + +* **SLACK Discussion platform:** [**Join to interact with community!**](http://slack.codeuino.org) +* **Contact Email:** [rgsoc@codeuino.org ](mailto:rgsoc@codeuino.org) + +## **Involving as a Student under Codeuino** + +**Create your application at** [**https://teams.railsgirlssummerofcode.org/apply**](https://teams.railsgirlssummerofcode.org/apply)\*\*\*\* + +### Before Being Accepted + +If you are a student, you can start exploring project ideas towards the RGSoC application phase. Each project contains contacts to reach out to potential mentors, and many projects have also been listed with some ongoing issues. Students are requested to get involved with the community in order to carry with projects. + +1. **Become familiar with Codeuino Community** and the project\(s\) for which you're applying. Read the [Get Involved Guide](http://codeuino.org/getInvolved.html) and ask others in the community if you have questions. If you [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html), you'll get better responses. +2. **Make sure your development environment is installed and running,** and optimized for maximum efficiency. +3. **Review project ideas listed here & ask questions** about those or other projects in the here +4. **Spend as much time as possible** in our [SLACK](http://codeuino.slack.com) channel. Here is the [link to join the communication channel](http://slack.codeuino.org). +5. **Introduce yourself** within the community. +6. Run, Test and identity some potential issues in [Codeuino Github Repositories](https://github.com/codeuino) +7. **Increase your visibility by suggesting ideas** Suggest new ideas and participate in to other's discussions as much as possible in order to have a fruitful outcome. +8. **Get Knowledge about RGSOC** by understanding it and reading about it on their [Manual](https://railsgirlssummerofcode.org/students/application/) + +#### **NOTE: Students can also propose their own ideas that they want to include within the community** + +### After Being Accepted + +1. **Set up a blog** for your work on open source projects, including RGSoC. If you don't have a blog yet, you should create one. **You will be required to write a blog post every week about your planning work and project progress during RGSoC. This will be "Progress Report".** +2. **Contact your mentor immediately.** Make a plan to communicate with them regularly. You would be required to communicate publicly within the \#RGSOC channel inside the SLACK unless something is private. +3. **Prepare a detailed project plan** together with your mentor. This will include setting up milestones for every week. +4. **Prepare mid-term & final project presentation videos** about your project's status, progress, and any questions you have for the community. + + You will asked to submit it through google drive which can be published from **"**[**Codeuino YouTube Channel**](https://www.youtube.com/channel/UCmC2EOPv_oyJIevTyzlZTDQ)**"** + +5. **Attend weekly meetings with potential mentors** explaining them your work in every week through Google Hangouts. + +### After Completion of RGSOC + +1. **Write a final blog post** summarizing your overall experience! If you like, talk to the org admins for consideration to cross-post this article to the Google Open Source Blog. +2. **Stay involved with your project** or other projects as your schedule permits! There is always plenty of development work needed. +3. **Continue to be involved with Codeuino Community** for additional questions or feedback about your RGSoC project, and for other topics that interest you. +4. **Present your project in events, Conferemnces and other related meetups.** +5. **Participate as a mentor/Volunteer for Rail Girl Summer of Code, Google Summer of Code, Google Code-in,** and other related programs. + +## **Involving as a Mentor** + +Potential mentors are invited to assign themselves on the projects they want to mentor this summer under Codeuino community. The person who is willing to mentor takes up the project within the community and propose it under RGSOC on the basis of involvement and prior knowledge of it. + +Mentoring takes about 5 to 6 hours of work per week \(more at the start, less at the end\). In return, a student works on your project full time for 3 months. Think about the projects that you’ve always wanted to do but could not find the time. + +**Consider proposing your own ideas as well that match the community project style**. + +Make sure you get through the **"**[**Mentor Guide**](https://railsgirlssummerofcode.org/guide/projects/)**"** + +### Expectations from a mentor + +1. **Commit to spending a minimum of 4 hours each week** to be available to guide and mentor students \(not just your assigned student\). +2. **Commit to being present** in SLACK to help answer questions as much as your schedule allows, at a minimum of 4 hours each week. +3. **Prepare a good overview of your project** idea\(s\) +4. **Review student proposals** and work with other mentors and organization admins to select the best candidates for Codeuino. +5. **Ensure your Student is Active.** They should have a good community involvement and good discussions. Should be answerable wherever they are tagged. +6. **Reach out to the Summer of Code organization administrators** if you have questions or concerns. +7. **Do weekly meeting with students and give weekly report to Organization Admins.** + +## Project Ideas + +### Project description + +Codeuino is an open source social networking organisation that tends to work for building social environments for communities, allowing them to use in their custom way. Codebadge stands out as one of the community run project which aims to support contributors with badges and allowing Community admins/moderators to use it in their custom way for every contributor involved through their contribution in the organizations. We are developing a FOSS tool that allows ones to create badges and integrate them with their forums which is based on github commits. It has got more enhanced features which allow them with analytics, drafting, allotment and many more. + +We are designing admin dashboard through which he/she can set the criterias for badge allotment, and analyse the project progress and allot issues on the basis of past contributions. We are also willing to enhance our Codebadge illustrator by adding new functionalities. + +The coaches who will be helping you out remotely are:- + +* [Jaskirat Singh](https://github.com/jaskirat2000) +* [Ayush Nagar](https://github.com/ayushnagar123) + +### Project's Requirements + +Students shall have knowledge of:- Creating and Working with github APIs Creating restful apis in flask api for illustrator for machine learning features. Html canvas, vuejs, css, javascript for ui designing. + +### Task and Features + +This project includes working on various tasks such as development of Organisation Admin dashboard and UI builder \(Illustrator\) + +**1. Organisation Admin's panel:-** + +* Search by username, his contributions in the community. +* Searching on the basis of project all contributors on the basis of project. +* Displaying analytics such as charts of progress of each projects and other related things. +* Displaying chart of contributions by an organization member. +* Displaying tech stack and issue type he has contributed to\(such as designing,enhancement, bug solving\) +* Suggesting issues assignment to contributor on the basis of past experience.\(7-8 days\) + +**2. Illustrator:-** This tool involves visual editor or we could say visual UI builder with just drag and drop inside the dashboard. + +* Displaying image on html canvas. +* Move tool with js. +* Resize image on drag with js. +* Quick Selection tool using js and Python. +* Puppet wrap using js and Python. +* Layers using js and Flask. +* Pick tool using Python. +* Pen tool using js + diff --git a/codeuino-docs.md b/codeuino-docs.md index 287d7f1..fc08190 100644 --- a/codeuino-docs.md +++ b/codeuino-docs.md @@ -4,15 +4,13 @@ description: >- documentation. --- -# CodeUino Docs +# Codeuino Projects ## 1. Social Platform Donut -{% page-ref page="donut-docs/donut-documentation/" %} +{% page-ref page="projects/social-platform-donut/" %} ## 2. Codebadge -{% page-ref page="codebadge/codebadge-documentation/" %} - - +{% page-ref page="projects/codebadge/" %} diff --git a/community-guidelines.md b/community-guidelines.md new file mode 100644 index 0000000..478ef54 --- /dev/null +++ b/community-guidelines.md @@ -0,0 +1,36 @@ +# Community Guidelines + +### Things you should take into consideration! + +\*\*\*\*👋 **Be welcoming and open-minded** - Other collaborators may not have the same experience level or background as you, but that doesn't mean they don't have good ideas to contribute. We encourage you to be welcoming to new collaborators and those just getting started. We value, encourage all types of contributions. We don’t assume you can contribute for free, we respect and thank. + +\*\*\*\*😇 **Be honest -** Being honest helps you to move to a better consensus building. So Be honest about who you are, what you do, and how you want to do it. Dishonesty is not only damaging to you but to all other community members and their valuable contributions. Don’t be the one bringing mistrust into this community. + +\*\*\*\*😊 **Be Kind -** We value caring for others. Demonstrating we care for people provides an effective framework for challenging directly and delivering feedback. We're all for accurate assessment, but we think it must be done in a kind way. Give as much positive feedback as you can, and do it in a public way. + +\*\*\*\*✍ **Be considerate** - Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect the users and the contributors working on a particular project, So you should keep those consequences in mind while making any decision. + +\*\*\*\*🤝 **Be collaborative -** Codeuino community has various projects which work on the basis of working together and collaboration. So Collaboration is an essential part for us. Collaboration between teams that each user has their own goal and vision which is essential; for the whole to be more than the sum of its parts, each part must make an effort to understand the whole. + +\*\*\*\*🎯 **Be thoughtful and stick to topic -** The Codeuino community is the house of social networking projects. So being a social networking community it fulfills social needs to interact with people around the globe. So off-topic comments are sometimes unproductive while collaborating. Staying on topic helps produce positive and productive discussions. Additionally, communicating with strangers on the Internet can be difficult. It's hard to convey or read tone, and sarcasm is frequently misunderstood. Try to use clear language, and think about how it will be received by the other person. + +\*\*\*\*🙉 **Be apologize** - If you made a mistake, apologize as soon as possible. Saying sorry is not a sign of weakness but one of strength. The people that do the most work will likely make the most mistakes. Additionally, when we share our mistakes and bring attention to them, others can learn from us, and the same mistake is less likely to be repeated by someone else. Mistakes can include when you have not been kind to someone. In order to reinforce our values, it is important, and takes more courage, to apologize publicly when you have been unkind publicly \(e.g., when you have said something unkind or unprofessional to an individual or group in a Slack channel\). + +\*\*\*\*👐 **Be helpful -** Keep an eye out for others who may be struggling or stuck. If you see someone who needs help, reach out and assist, or connect them with someone else who can provide expertise or assistance. We succeed and shine together! + +### Things that are not allowed! + +{% hint style="info" %} +**NOTE:** This is to let you know that the below context has been taken from the [**GitHub community guidelines**](https://docs.github.com/en/github/site-policy/github-community-guidelines#what-is-not-allowed) ****which are under ****[**CC0 1.0 license**](https://creativecommons.org/publicdomain/zero/1.0/)\*\*\*\* +{% endhint %} + +* **Threats of violence** - You may not threaten violence towards others or use the site to organize, promote, or incite acts of real-world violence or terrorism. Think carefully about the words you use, the images you post, and even the software you write, and how they may be interpreted by others. Even if you mean something as a joke, it might not be received that way. If you think that someone else _might_ interpret the content you post as a threat, or as promoting violence or terrorism, stop. Don't post it anywhere. In extraordinary cases, we may report threats of violence to law enforcement if we think there may be a genuine risk of physical harm or a threat to public safety. +* **Hate speech and discrimination** - While it is not forbidden to broach topics such as age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation, we do not tolerate speech that attacks a person or group of people on the basis of who they are. Just realize that when approached in an aggressive or insulting manner, these \(and other\) sensitive topics can make others feel unwelcome, or perhaps even unsafe. While there's always the potential for misunderstandings, we expect our community members to remain respectful and civil when discussing sensitive topics. +* **Bullying and harassment** - We do not tolerate bullying or harassment. This means any habitual badgering or intimidation targeted at a specific person or group of people. In general, if your actions are unwanted and you continue to engage in them, there's a good chance you are headed into bullying or harassment territory. +* **Impersonation** - You may not seek to mislead others as to your identity by copying another person's avatar, posting content under their email address, using a similar username, or otherwise posing as someone else. An Impersonation is a form of harassment. +* **Doxxing and invasion of privacy** - Don't post other people's personal information, such as phone numbers, private email addresses, physical addresses, credit card numbers, Social Security/National Identity numbers, or passwords. Depending on the context, such as in the case of intimidation or harassment, we may consider other information, such as photos or videos that were taken or distributed without the subject's consent, to be an invasion of privacy, especially when such material presents a safety risk to the subject. +* **Sexually obscene content** - Don’t post content that is pornographic. This does not mean that all nudity, or all code and content related to sexuality, is prohibited. We recognize that sexuality is a part of life and non-pornographic sexual content may be a part of your project, or may be presented for educational or artistic purposes. We do not allow obscene sexual content or content that may involve the exploitation or sexualization of minors. +* **Gratuitously violent content** - Don’t post violent images, text, or other content without reasonable context or warnings. While it's often okay to include violent content in video games, news reports, and descriptions of historical events, we do not allow violent content that is posted indiscriminately, or that is posted in a way that makes it difficult for other users to avoid \(such as a profile avatar or an issue comment\). A clear warning or disclaimer in other contexts helps users make an educated decision as to whether or not they want to engage with such content. +* **Misinformation and disinformation** - You may not post content that presents a distorted view of reality, whether it is inaccurate or false \(misinformation\) or is intentionally deceptive \(disinformation\) because such content is likely to result in harm to the public or to interfere with fair and equal opportunities for all to participate in public life. For example, we do not allow content that may put the well-being of groups of people at risk or limit their ability to take part in a free and open society. We encourage active participation in the expression of ideas, perspectives, and experiences and may not be in a position to dispute personal accounts or observations. We generally allow parody and satire that is in line with our Acceptable Use Polices, and we consider context to be important in how information is received and understood; therefore, it may be appropriate to clarify your intentions via disclaimers or other means, as well as the source\(s\) of your information. +* **Active malware or exploits** - Being part of a community includes not taking advantage of other members of the community. We do not allow anyone to use our platform for exploit delivery, such as using GitHub as a means to deliver malicious executables, or as attack infrastructure, for example by organizing denial of service attacks or managing command and control servers. Note, however, that we do not prohibit the posting of source code which could be used to develop malware or exploits, as the publication and distribution of such source code has educational value and provides a net benefit to the security community. + diff --git a/design-guidelines/README.md b/design-guidelines/README.md new file mode 100644 index 0000000..d9627fd --- /dev/null +++ b/design-guidelines/README.md @@ -0,0 +1,43 @@ +# CodeUino Design + +## CodeUino Design + +![](../.gitbook/assets/artboard-2%20%281%29.jpg) + +### What is CodeUino Design? + +As the community is being mobilized, and as all its members participate in the choices about what action to undertake in design, it becomes useful to combine those choices and decisions and lay some guidelines. CodeUino Design is a place where we aim to solve design issues and improve the design structure of our platforms. + +We aim to solve the design issues and bring the community closer through regular discussions and brain storming sessions. This helps keep the community intact and grow in a larger scale. + + + +### What are we trying to achieve? + +We as a community are trying to achieve a certain number of goals through design. + +* Well defined and constructed design solutions for community products and maintain standard design guidelines and design library. +* Bring the community together through design sprints and regular discussions over designs. +* Build a better bridge between designers and developers to speed up the processes and improve the productivity. + + + +### Why should you contribute? + +Although, Open source is majorly for developers, our organization opened gates for designers as well. We believe that anyone can leave their mark on an important piece of open software or create their own “next big thing”. There are several reasons why you should contribute in design. + +* Being part of an open source project can also help you improve your skills and learn new tools and processes. +* Our community consists of some amazing peeps from whom you could get mentorship, mentor others or form life long friendships. +* Design varies in every company and community. We adapt the latest and the most trusted methods to ideate, create and design for our platforms. + + + +### How can you contribute? + +You can contribute to the community in several ways. + +* User Interface Design \(UI\) +* User Experience Design \(UX\) +* Graphic Design +* User Research and Documentation + diff --git a/design-guidelines/contributing-to-design.md b/design-guidelines/contributing-to-design.md new file mode 100644 index 0000000..25d9b05 --- /dev/null +++ b/design-guidelines/contributing-to-design.md @@ -0,0 +1,67 @@ +# Contributing to Design + +### Things you need to know + +What is CodeUino? + +What is CodeUino Design? + +What is our design workflow? + + + +### Things you need to follow + +As a community, we follow some design principles to improve the understanding of the process of design and ease the workflow. Before starting to design, we need you to understand the principles and put them in use while contributing. + +### 1. Data Empower Us + +Data expels the guesswork from our plans. We let it guide our decision-making skills to produce amazing products and designs. Be that as it may, we don't allow data to drive or evacuate our creativity and interest. We have to comprehend the data and have a gut of what is correct or wrong. + +### 2. Be Minimalist + +We make sure that our designs are simple and minimalist. We never take "that is how it is" for an answer. Making something straightforward and simple to utilize is constantly harder than making it complicated, yet it's something we believe is right. + +### 3. User comes first + +Keep the user in mind. We can't design the right thing if we don't know who the user is. That is why keep users in mind, have empathy for them and empower them rather than overwhelming them. + +### 4. Be Consistent + +Consistency makes users acquainted with our idea and plans. Our messages are clear and are imparted through basic and familiar designs. If that way works, we reuse designs rather than re-designing them. + +### 5. Designs Are Forgiving + +We comprehend that there is nothing of the sort as a perfect design and nothing can prevent all mistakes. That is why our designs allow users to recover from mistakes. The capacity to fix builds trust in our designs. + +## Get Started + +### Github + +All the design tasks are found in CodeUino's Github repository and are marked with the label "design". - [CodeUino Github](https://github.com/codeuino/) + +1. Search for design labels in the complete issue list. +2. Comment on the issue, confirm with others and start working on the issue. + +## Types of Issues + +### Graphic Design + +This includes corporate design \(logos and branding\), Illustrations, marketing design \(posters, banners\), advertisements, communication design and signage. + +**Tools:** Adobe Photoshop, Adobe Illustrator, Figma, GIMP + +### UI/UX Design + +This is the major part of the design in the community. It consists designing of UI screens, Wire-frames and Hi-fidelity mock-ups for both web and mobile devices. + +**Platform:** Figma + +### UX Documentation + +This contains User Interviews, Surveys, Affinity cards, Wire-flows, User personas, User journey and other design documents which contain our thought process and workflow. + +**Platform:** Gitbook + + + diff --git a/design-guidelines/contributing-to-product-research.md b/design-guidelines/contributing-to-product-research.md new file mode 100644 index 0000000..8e9bf20 --- /dev/null +++ b/design-guidelines/contributing-to-product-research.md @@ -0,0 +1,58 @@ +# Contributing to Product Research + +### Things you need to know? + +What is CodeUino? + +What are features of CodeUnio projects? + +What is our working flow? + + + +### Things you need to follow + +As a community, we follow some research principles to improve the projects and introduce new features which are most demanding. Before getting started, we need you to know the process which we believe and you should follow that while contributing. + +### 1. What is Product Research? Why is it important? + +Product research helps to understand the users in a better way. Research can provide more information on the specifications and requirements which are raised by the users. If there is any solution which exists, then the research will help us to understand that and we can get to know whether the current solutions meet the proper requirements or not. This way we can learn what we can provide differently which is in favour of users. + +### 2. What are the expectations? + +You should be able to study the current similar products available in the market and find out what new features are they providing. If you find any features which are provided in other products but they are not as per requirements of the user, then you should be able to validate that by doing a survey that what point is lacking. In the end you should submit the report which includes your studied product details, how many users you have reached for validations and what new can we implement. + + + +## **Get Started** + +### 1. What should be your approach and process of work + +Whenever you start your work, keep the user in mind. User is going to use the product. Steps you need to follow : + +* Find the similar product which are available in the market. Do some study of features provided by that product. +* Find out what new implementations or integrations does that product have and what values does that feature provide to the user. + * You can do this by performing a survey and asking questions to the users. + +And after that you should be able to justify whether that features are useful for users. Along with this, you need to find some ideas which are the most trending or required features for the users. + +### 2. Idea Validation + +You should follow the process of Design Thinking. + +![](../.gitbook/assets/designthinking.png) + +* It is fine if you skip the empathize step. But we highly recommend to follow this step. If possible you can run the project on your machine locally and try to think of ideas. +* Define the ideas which you find useful to the users when implemented in Codeuino projects +* Contact any of the project members and discuss the idea's feasibility and importance. +* Finalize the idea and if possible think of some visuals +* Document each and everything and submit to us after ideation stage +* Get involved in the process of finalizing the new feature and prototype stage +* Get the prototypes and test that with some users and get the feedback. + +### 3. Submit your analysis + +You should document your each and every work and submit it to us in a pdf format along with the statistics of surveys you have performed. + + + diff --git a/donut-docs/donut-documentation/donut-design-guidelines/design-workflow.md b/design-guidelines/design-workflow.md similarity index 71% rename from donut-docs/donut-documentation/donut-design-guidelines/design-workflow.md rename to design-guidelines/design-workflow.md index d6bb162..3ae328d 100644 --- a/donut-docs/donut-documentation/donut-design-guidelines/design-workflow.md +++ b/design-guidelines/design-workflow.md @@ -13,18 +13,16 @@ We follow a 4-query procedure to solve the design issues. Each question is a ste ### Sprints -To increase the productivity, we follow sprint cycles which roughly are for 10-15 days. Everything from Ideating, designing, prototyping and re-iterating come under each sprint. - -![](../../../.gitbook/assets/assets_-lsv46f7uzuvdedvews0_-ltflz2mqkow25nhe1al_-ltfm3no_hb7me2lxeku_artboard-1.jpg) - +To increase productivity, we follow sprint cycles which roughly are for 10-15 days. Everything from Ideating, designing, prototyping and re-iterating come under each sprint. +![](../.gitbook/assets/assets_-lsv46f7uzuvdedvews0_-ltflz2mqkow25nhe1al_-ltfm3no_hb7me2lxeku_artboard-1.jpg) ### Why Sprints? There are several reasons why we have implemented sprints in our design system. -* Time constraint boosts creativity and forces you to make product decisions quickly thereby increasing our productivity. +* Time constraint boosts creativity and forces you to make product decisions quickly, thereby increasing our productivity. * Team alignment. Having the whole team work closely together on the same goal and with the same information is intensely uniting. -* To get a better idea of the problem and a larger view on the overall product. +* To get a better idea of the problem and a broader view of the overall product. * Prototyping frees you from the traditional time and money constraints of building a product to test it. diff --git a/design-guidelines/product-research-workflow.md b/design-guidelines/product-research-workflow.md new file mode 100644 index 0000000..462a159 --- /dev/null +++ b/design-guidelines/product-research-workflow.md @@ -0,0 +1,27 @@ +# Product Research Workflow + +## Our Aim + +Our aim through this procedure is to find and validate the current trending features which users want to see in social networking projects. + +## Our Process + +We follow a 4-step process for product research and finding new ideas. Each step is a forward move towards a contribution + +* **Discovery** **:** Empathize and find the potential users. Study their behaviour, interactions, expectations, etc. +* **Explore :** Explore the different features provided by other products and different needs of users +* **Ideate :** Finalize the ideas and validate them +* **Test :** Test the prototypes and take valuable feedbacks + + + +### Why this Process? + +There are several reasons for selecting this process. + +* Exploration of ideas and users plays a very crucial role in part of product research. If you target the wrong users for study then this will create an enormous problem in further stages. +* Along with these exploration of different features are also very important. This part works as a base of thinking of new ideas and improving the current ideas +* And at last ideation and testing stage involves the part of discovering and finalising new features. + +\*\*\*\* + diff --git a/design-guidelines/visual-identity.md b/design-guidelines/visual-identity.md new file mode 100644 index 0000000..1edc437 --- /dev/null +++ b/design-guidelines/visual-identity.md @@ -0,0 +1,99 @@ +# Codeuino Visual Identity + +### What is Visual Identity? + +Visual identity is the visible elements of a brand, such as color, design, and logo, typography and the symbol that identify and distinguish the brand in consumers' minds. + +### Why these Guidelines? + +For any logo to be memorable and have the desired recall value, it is necessary that it be portrayed across all platforms in a consistent manner. The components of the Logo should be consistently used. It ensures that platform stands out and= and makes the platform easily identifiable. + +These guidelines have been laid out to improve the visual application of the Logo of Donut, A social media application. + + +### Who should use this? + +It is for the use of developers, designers and others who may use the logo. The document lays down all the guidelines of how and where should the logo be used. It is important that the logo remains consistent across all platforms, signage and marketing collateral. + + +## Codeuino Visual Identity + +### Logo + +#### Standard Logo - Vertical + +![Vertical](../.gitbook/assets/artboard-1-copy-2.jpg) + +#### Standard Logo - Horizontal + +![Horizontal](../.gitbook/assets/artboard-1-copy-3.jpg) + +#### Logo Mark + +![Logomark](../.gitbook/assets/artboard-1-copy-4.jpg) + +{% file src="../.gitbook/assets/colored-horizontal.svg" caption="Standard Logo - Horizontal - SVG" %} + +{% file src="../.gitbook/assets/colored-horizontal.png" caption="Standard Logo - Horizontal - PNG" %} + +{% file src="../.gitbook/assets/colored-vertical.svg" caption="Standard Logo - Vertical - SVG" %} + +{% file src="../.gitbook/assets/colored-vertical.png" caption="Standard Logo - Vertical - PNG" %} + +{% file src="../.gitbook/assets/colored-logomark.svg" caption="LogoMark - SVG" %} + +{% file src="../.gitbook/assets/colored-logomark.png" caption="LogoMark - PNG" %} + + + +#### Presentation + +While presenting the logo, Use the Codeuino-White logo with Codeuino-Blue as background. + +![Presentation](../.gitbook/assets/artboard-4.jpg) + +{% file src="../.gitbook/assets/presentation-logo-horizontal.jpg" caption="Presentation Logo - Horizontal" %} + +{% file src="../.gitbook/assets/presentation-logo-vertical.jpg" caption="Presentation Logo - Vertical" %} + +{% file src="../.gitbook/assets/presentation-logo-logomark.jpg" caption="Presentation Logo - LogoMark" %} + +### + +### Colour palette + +**Chromatic colours** + +Codeuino Blue \(\#25257C\) is the main colour of the Codeuino identity so it has the strongest presence on our brand. +**** + +**Achromatic versions :** + +Codeuino White \(\#FFFFFF\) +Codeuino Black \(\#000000\) + + +{% file src="../.gitbook/assets/achromatic-white.zip" caption="Achromatic - White - SVG, PNG" %} + +{% file src="../.gitbook/assets/achromatic-black.zip" caption="Achromatic - Black - SVG, PNG" %} + + + +### Typefaces + +#### **Primary and Secondary Font** + +Inter is both the primary and secondary font of Codeuino. + +![](../.gitbook/assets/font.jpg) + +The font files can be downloaded from [GITHUB](https://github.com/rsms/inter/tree/master/docs/font-files) + +#### + +#### Font Weights + +Variations of font weights can be used while presenting text. + +![](../.gitbook/assets/artboard-3.jpg) + diff --git a/development/README.md b/development/README.md new file mode 100644 index 0000000..00c0f18 --- /dev/null +++ b/development/README.md @@ -0,0 +1,58 @@ +# Development + +## Technical Requirements + +You'll need to have some basic programming experience with the technologies and tools we use. + +### Tools + +* **Git & GitHub** - Clone, commit and open a PR using Git and GitHub. Check out the following tutorials: + + * [Introduction to git](https://www.freecodecamp.org/news/what-is-git-and-how-to-use-it-c341b049ae61/) + * [Introduction to GitHub](https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners) + * [Popular git commands and how to use them](https://rogerdudler.github.io/git-guide/) + * [Git commands in-depth](https://medium.com/@george.seif94/a-full-tutorial-on-how-to-use-github-88466bac7d42) + * [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) + * [Markdown Tutorial](https://www.markdowntutorial.com/)\*\*\*\* + +### Tech Stack + +Projects under the Codeuino Community are primarily **JavaScript** based and leverage several frameworks and libraries. In all of the projects, **React** is used on the frontend and the backend is written in **Node.js** with **Express** framework. **MongoDB** and **Redis** are used for persistent and in-memory storage respectively. **Socket.IO** is used for notifications using WebSockets. Some projects also use GraphQL. Apart from these various npm packages are used in different projects. + +We recommend having good understanding of JavaScript basics like Promises, Async/await, ES6 etc and at least some experience working with Node/Express, React and MongoDB to get started. Check out these free resources to sharpen your tech skills: + +* JavaScript + * [Introduction to basic principles of JavaScript](https://eloquentjavascript.net/) + * [Introduction to JavaScript - w/ Advanced concepts](https://javascript.info/) + * [An interactive JavaScript tutorial](https://www.learn-js.org/) +* React + * [React Official docs and tutorials](https://reactjs.org/docs/getting-started.html) + * [React Router Official docs](https://reactrouter.com/web/guides/quick-start) +* Node.js / Express.js + * [Quick introduction to Node.js](https://www.tutorialspoint.com/nodejs/nodejs_quick_guide) + * [Introduction to Node.js - w/ quizzes](https://www.tutorialsteacher.com/nodejs/nodejs-tutorials) + * [When, how and why to use Node.js](https://www.netguru.com/blog/use-node-js-backend) + * [Differences between JavaScript and Node.js](https://www.educba.com/javascript-vs-node-js/) + * [ExpressJS official guides and API reference](http://expressjs.com/en/4x/api.html) + * [Learn ExpressJS - Tutorial](https://www.tutorialspoint.com/expressjs/index.htm) +* Socket.IO + * [Socket.IO Official docs](https://socket.io/docs/) + * [Learn Socket.IO - tutorial](https://www.tutorialspoint.com/socket.io/index.htm) +* MongoDB + * [The MongoDB Manual - Official MongoDB documentation](https://docs.mongodb.com/manual/) + * [Mongoose - Official documentation](https://mongoosejs.com/docs/index.html) +* Redis + * [Redis Official documentation](https://redis.io/documentation) + * [Learn Redis - Tutorial](https://www.tutorialspoint.com/redis/index.htm) + +## Codeuino's Project Structure + +The Codeuino takes into the house of development of the 3 social networking projects and they have been divided into the following ways: + +* **Donut - Social Media Platform** + * \*\*\*\*[**codeuino / social-platform-donut-frontend**](https://github.com/codeuino/social-platform-donut-frontend) **-** This repository contains the frontend part of the donut platform. + * \*\*\*\*[**codeuino / social-platform-donut-backend**](https://github.com/codeuino/social-platform-donut-backend) - This repository contains the backend part of the donut platform. +* **Spansberry - Community-Oriented Discussion Platform** + * \*\*\*\*[**codeuino / community-forum-backend**](https://github.com/codeuino/community-forum-backend) **-** This repository contains the backend part of the Spansberry platform. + * \*\*\*\*[**codeuino / community-forum-frontend**](https://github.com/codeuino/community-forum-frontend) - This repository contains the frontend part of the Spansberry platform. + diff --git a/development/contribution-worklfow.md b/development/contribution-worklfow.md new file mode 100644 index 0000000..7f3c75a --- /dev/null +++ b/development/contribution-worklfow.md @@ -0,0 +1,75 @@ +# Contribution Worklfow + +### Contribution Approach + +We love pull requests from everyone! We follow the standard Git workflow of **`fork`** 👉 **`change`** 👉 **`pull request`** 👉 **`merge`** 👉 **`update fork`** 👉**`change`** ... \(**repeat forever**\). If you are new to open source, we recommend GitHub's excellent guide on "[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)". In addition, please feel free to reach out to any of the maintainers or other community members if you are struggling; we are here to help you learn! + +Before getting started, please make sure you've read the **README** of the respective project repository to get a primer on our project. + +### Opening an Issue + +If you're experiencing an issue with any project or have a question you'd like help answering, please feel free to open an issue in the respective repository of the project. To help us prevent duplicates, we kindly ask that you briefly search for your problem or question in our issues before opening a new one. + +Please note that if you open a bug report and your issue does not follow our template, we cannot help you until you have provided us all the relevant information in that format. Respectfully, we do not have the time to try and recreate an error given with minimal or no context, so by providing this information you are helping us help you! You will see this template when you open an issue; click on "Bug Report" and it will be populated with descriptions of what to put in each section. Replace the descriptions with your comments to the best of your ability, and please include screenshots and error logs if applicable. + +### Contributing to Source Code + + Help is always welcome, be it any form, whether it is working on the documentation process or solving an issue. It is the best way to get along with the community. You can view all the issues on our GitHub Organization. + +**Important !!** You need to be logged in before you follow the issues link. They will give you a glimpse of what it’s like to work with us and what the workflow is like. + +#### Cloning the GitHub repository + +The git clone command is used to copy an existing Git repository from a server to the local machine. To clone our git repository follow these steps in your terminals\(This is just an example of website repo\):- + +```text +git clone https://github.com/Codeuino/website-www.Codeuino.org.git +cd website-www.codeuino.org / +``` + +Now pick an issue that isn’t assigned and which you would like to fix. Leave a comment that you would like to work on that particular issue. This way we don’t have multiple people working on the same issue at the same time. After this, you can start working on it. + +{% hint style="info" %} +**NOTE:** You should never work on an issue without being assigned. Also take up the issue, only when you know what the problem is and how to solve it. +{% endhint %} + +#### Forking and Testing the Modifications + +You should first fork the repository by visiting the official repository of Codeuino and clicking on the button Fork. This step is needed only once. + + **Important !!** It is important that you DO NOT make your changes on the master branch of your forked repository as you cannot have two pull requests using the same branch name. Therefore, if your fork’s master has been used in a pull request and you decide to work on a different issue you will have to branch eventually. Differently, every new commit that you make on your master branch will get attached to the initial pull request and that will result in altering the purpose of that request. + +#### Branching + +You can create a branch per set of changes. To do that run: + +```text +$ git checkout -b branchname +``` + +where your branch name can be anything other than master. The scope is your forked repository. The branch name will be shown on the pull request. Before pushing the pull request, you must test your changes with some concrete examples. + +#### Sending the Pull request + +Now that your commit has been sent to your fork, it is time to create a Pull Request. You can do this by accessing your fork on GitHub and clicking the New Pull Request. + +{% hint style="info" %} +**NOTE:** Comments are always welcomed, as the readability of the code becomes easy for the other developers. +{% endhint %} + +**Creating a Pull Request:-** If you've forked a repository and made changes to the fork, you can ask that the upstream repository accept your changes by creating a pull request. + +{% hint style="info" %} +**NOTE:** To open a pull request in a public repository, you must have write access to the head or the source branch or, for organization-owned repositories, you must be a member of the organization that owns the repository to open a pull request. +{% endhint %} + +* Navigate to the original repository you created your fork from. +* To the right of the Branch menu, click **New pull request.** +* Type a title and description for your pull request. +* If you do not want to allow anyone with push access to the upstream repository to make changes to your PR, deselect **Allow edits from maintainers.** +* Click **Create pull request.** + +{% hint style="warning" %} +**Source Citation:** This page has been inspired from the [**CHAOSS Contributing Workflow page**](https://chaoss-project.gitbook.io/community-handbook/development/contributing-worfkflow). +{% endhint %} + diff --git a/documentation.md b/documentation.md new file mode 100644 index 0000000..b4eff24 --- /dev/null +++ b/documentation.md @@ -0,0 +1,31 @@ +# Documentation + +So you're thinking of contributing to our documentation? Amazing! We really appreciate contributing to the docs because documentation plays an important role in any open source project to get started. So in order to chime in see something that needs fixing, or something that could be improved. Below you'll find some helpful guidelines to get you started, and to familiarize you with the approach we have been trying to follow. + +{% hint style="info" %} +NOTE: Our documentation is located and hosted on Gitbook. Link to the documentation - [**docs.codeuino.org**](https://docs.codeuino.og)\*\*\*\* +{% endhint %} + +In general, there are two main types of contributions: + +* **General improvements**: typo corrections, fixing broken refs or links, correcting inaccurate or out-of-date information, and offering better explanations through clearer writing and additional examples. +* **New features or new pages**: Adding a page of documentation that we haven't yet covered in our ongoing rewrite attempts as we move platforms, or documenting a new feature that has been added to Codeuino Projects since the last release. + +### Before Contributing + +**Understand that our documents are all released under a Creative Commons Attribution-ShareAlike 4.0 license** \([CC BY SA](http://creativecommons.org/licenses/by-sa/4.0/)\). This means that your contributions are being released to the Codeuino community to use, share, remix, and distribute as they see fit, provided any distribution takes place under the same licensing. + +**Read through some of the documents we've already created**. You'll notice that there is a consistent structure to most of them, which we will describe in greater detail below. By reading through some of our existing documentation, you will get a feeling for the overall structure and style. + +**Familiarize yourself with GitBook and Markdown.** As mentioned above that ****our documentation is hosted on the [**Gitbook**](https://www.gitbook.com/) platform and it is always suggested that you should get through the [**GitBook Docs**](https://docs.gitbook.com/) that demonstrate how to make edits or work with the gitbook platform. + +**Make your contributions in the right place**. Are you contributing to the latest version of our docs, so that these improvements will be carried forward in the next version? + +**Use the best resources and mindful thoughts while documenting.** You should make the documentation more impressive by adding Images, GIFs, Videos, etc. + +{% hint style="info" %} +**Source Citation:** [https://wiki.accesstomemory.org/wiki/Resources/Documentation/Contribution\_guidelines](https://wiki.accesstomemory.org/wiki/Resources/Documentation/Contribution_guidelines) under "Before Contributing" headline +{% endhint %} + +**Once you have read the "Before Contributing" section make sure you jump into the "Working with Changes" section** + diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 0000000..b4eff24 --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,31 @@ +# Documentation + +So you're thinking of contributing to our documentation? Amazing! We really appreciate contributing to the docs because documentation plays an important role in any open source project to get started. So in order to chime in see something that needs fixing, or something that could be improved. Below you'll find some helpful guidelines to get you started, and to familiarize you with the approach we have been trying to follow. + +{% hint style="info" %} +NOTE: Our documentation is located and hosted on Gitbook. Link to the documentation - [**docs.codeuino.org**](https://docs.codeuino.og)\*\*\*\* +{% endhint %} + +In general, there are two main types of contributions: + +* **General improvements**: typo corrections, fixing broken refs or links, correcting inaccurate or out-of-date information, and offering better explanations through clearer writing and additional examples. +* **New features or new pages**: Adding a page of documentation that we haven't yet covered in our ongoing rewrite attempts as we move platforms, or documenting a new feature that has been added to Codeuino Projects since the last release. + +### Before Contributing + +**Understand that our documents are all released under a Creative Commons Attribution-ShareAlike 4.0 license** \([CC BY SA](http://creativecommons.org/licenses/by-sa/4.0/)\). This means that your contributions are being released to the Codeuino community to use, share, remix, and distribute as they see fit, provided any distribution takes place under the same licensing. + +**Read through some of the documents we've already created**. You'll notice that there is a consistent structure to most of them, which we will describe in greater detail below. By reading through some of our existing documentation, you will get a feeling for the overall structure and style. + +**Familiarize yourself with GitBook and Markdown.** As mentioned above that ****our documentation is hosted on the [**Gitbook**](https://www.gitbook.com/) platform and it is always suggested that you should get through the [**GitBook Docs**](https://docs.gitbook.com/) that demonstrate how to make edits or work with the gitbook platform. + +**Make your contributions in the right place**. Are you contributing to the latest version of our docs, so that these improvements will be carried forward in the next version? + +**Use the best resources and mindful thoughts while documenting.** You should make the documentation more impressive by adding Images, GIFs, Videos, etc. + +{% hint style="info" %} +**Source Citation:** [https://wiki.accesstomemory.org/wiki/Resources/Documentation/Contribution\_guidelines](https://wiki.accesstomemory.org/wiki/Resources/Documentation/Contribution_guidelines) under "Before Contributing" headline +{% endhint %} + +**Once you have read the "Before Contributing" section make sure you jump into the "Working with Changes" section** + diff --git a/documentation/working-with-changes.md b/documentation/working-with-changes.md new file mode 100644 index 0000000..a6c485c --- /dev/null +++ b/documentation/working-with-changes.md @@ -0,0 +1,6 @@ +# Working with Changes + +## Understanding GitBook's integration with GitHub + +We use a platform called [GitBook](https://www.gitbook.com/) to host, manage and serve our documentation. GitBook fetches files from our GitHub repository Codeuino, reads them and converts them into the pages you can access on A generic structure of a documentation hosted on GitBook would look like this: + diff --git a/donut-docs/donut-documentation/donut-design-guidelines/contribute-to-design.md b/donut-docs/donut-documentation/donut-design-guidelines/contribute-to-design.md deleted file mode 100644 index 352c211..0000000 --- a/donut-docs/donut-documentation/donut-design-guidelines/contribute-to-design.md +++ /dev/null @@ -1,28 +0,0 @@ -# Contribute to Design - -### Things you need to know - -What is CodeUino? - - - -### Things you need to follow - - - -## Get Started - -### Graphic Design - - - -### UI/UX Design - - - -### UX Documentation - - - - - diff --git a/donut-docs/donut-documentation/donut-frontend/ about.md b/donut-docs/donut-documentation/donut-frontend/ about.md new file mode 100644 index 0000000..2c99c23 --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/ about.md @@ -0,0 +1,22 @@ +# About + +Being inspired by the Cornucopia of various social hub this project has been developed taking into consideration about open source. + +Well, this is an Open Source Social networking hub which acts as a bridge between various Developers, Organisations and Open Source aspirants to elaborate on various things like \#Projects, \#Events, \#Discussion on various researches, \#Scholarships, \#Coding release and various other things updates. + +The major priority of this project has been that this platform allows users to make their project "Open Sourced" and released them under various open source Organisations, experts which hold up a ring plate on this portal. + +This platform also makes users introduce and develops various solutions in the form of FOSS software to publish them for public use by integrating them with their social cause. Moreover, this project can be downloaded by any user, organization and can be used by them in their own custom way, making it run on their servers. + +## Technology Stack + +- CSS: Styling web pages, html files +- Javascript: Primary programing language +- ReactJS: Javascript library for building User Interfaces +- Bootstrap: Styling framework. + +## Communication + +- Slack - [Click here to join the codeuino slack channel](slack.codeuino.org) + +​ diff --git a/donut-docs/donut-documentation/donut-frontend/README.md b/donut-docs/donut-documentation/donut-frontend/README.md new file mode 100644 index 0000000..52ffcd9 --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/README.md @@ -0,0 +1,19 @@ +--- +description: This contains documentation related to frontend part of Social Platform Donut +--- + +# Donut Frontend + +## Table of Contents + +{% page-ref page="about.md" %} + +{% page-ref page="setting-up-the-work-environment.md" %} + +{% page-ref page="Setting-up-the-donut-webapp-locally.md" %} + +{% page-ref page="contributing-to-donut-frontend.md" %} + +{% page-ref page="design.md" %} + +{% page-ref page="code-of-conduct.md" %} diff --git a/donut-docs/donut-documentation/donut-frontend/Setting-up-the-donut-webapp-locally.md b/donut-docs/donut-documentation/donut-frontend/Setting-up-the-donut-webapp-locally.md new file mode 100644 index 0000000..6824f75 --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/Setting-up-the-donut-webapp-locally.md @@ -0,0 +1,56 @@ +# Setting up the donut frontend potion locally. + + **Forking The Repository** + +The first step of setting the donut frontend locally is to fork the original repository. This creates a copy of that repository under your own account enabling you to begin working with the code. The rights to public repositories will be such that you can view the code, but not directly commit into the repository or create branches. This allows the project owners to control changes within their codebase. + +The forking step creates a copy to which you do have permission to commit and branch on and you can consider this your working copy of the project. You can make changes and commits here, safe in the knowledge that you will not affect the main repository. + +In order to fork the donut frontend repository visit [here](https://github.com/codeuino/social-platform-donut-frontend) + +![](https://i.imgur.com/bWLML1u.png) + +**Cloning the forked repository** + +In order to clone the forked repository visit fork of the donut repository under "your repositories" section and click on the “Clone or download” which will open a UI showing the Git URL. A button to the right hand side of the URL allows you to copy it into your clipboard. + +![](https://i.imgur.com/2UyN3KV.png) +There are various graphical tools you can use to work with Git repositories but for simple procedures, the command line is often fastest. + +Open a command window and navigate to the path where you would like to clone the repository. +Use the following command to begin a clone: +``` +git clone https://github.com//social-platform-donut-frontend.git +``` +Once the command completes you will have a new folder containing the cloned repository. We can validate this by running the “dir” command. We can then move into that directory using the "cd " command. + +![image of command line](https://i.imgur.com/QsQy4Sg.png) + +**Setting up a remote upstream** + +The next step is to set up a remote. Remotes simply represent paths or URLs to other versions of your repository. In our case, as we cloned from our fork on GitHub a default remote will have been setup for us called origin. This origin allows us to push and pull code from our forked repository hosted on GitHub. We can list the currently configured remotes on our machine using the “git remote” command. + +Pushing and pulling from your own fork is very useful and this will be how you will work with the project most often. However, when working on that code, you’ll want to be starting from the most recent version of the code from the main donut-frontend repository. That code may have been updated and changed since you first made your fork. In order to get access to that latest code, we’ll setup a second remote which points to the main donut-frontend repository. We will not have commit rights there, so we cannot push changes, however, we will be able to fetch the latest commits that have occurred. + +To create a new remote we use the “git remote add” command, passing in a name for the new remote and the URL as arguments. In our case since we want the second remote to point towards the original donut-frontend repository we will use the follwing command. It's possible to name the remote anything you like, but the convention is to name it "upstream". + +``` +git remote add upstream https://github.com/codeuino/social-platform-donut-frontend.git +``` + +**Installing the dependencies and running our local version of donut-frontend** + +The next step is to install the required dependencies to our newly created donut-frontend app. This could be done by running the following command in the terminal. + +``` +npm install +``` + +The npm install command will install all the project dependencies mentioned in the package.json file. +Once all the dependencies are completely installed the final step is to run our local instance using the following command. + +``` +npm start +``` + +Now visit the [http://localhost:3000](http://localhost:3000) using your favorite browser to see your very own donut-frontend app in action! \ No newline at end of file diff --git a/donut-docs/donut-documentation/donut-frontend/code-of-conduct.md b/donut-docs/donut-documentation/donut-frontend/code-of-conduct.md new file mode 100644 index 0000000..3861a37 --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/code-of-conduct.md @@ -0,0 +1,76 @@ +# Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at codeuino@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/donut-docs/donut-documentation/donut-frontend/contributing-to-donut-frontend.md b/donut-docs/donut-documentation/donut-frontend/contributing-to-donut-frontend.md new file mode 100644 index 0000000..e4defa2 --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/contributing-to-donut-frontend.md @@ -0,0 +1,61 @@ +# Contributing to the donut frontend. + +**Choosing an issue** + +The first step when contributing to donut-frontend is to visit the project site and find an issue you would like to work on and which you think is suitable for your skillset. From the project homepage on GitHub, you can click the Issues tab to navigate to a list of the open issues. + + +![enter image description here](https://i.imgur.com/ncLCy84.jpg) + +After choosing an issue from the issues tab, click on that particular issue to view more details about it. The issue details page provides the full information about the issue. Usually, the top comment will include details of the bug or the feature that is needed. Issues can be raised by anyone and as a result, the level of detail may not always be sufficient to understand the problem or requirement. The project owners and core contributors try to view new issues and triage them. This involves verifying the issue being reported is valid and where necessary, providing some further details or guidance. If it’s not clear what is needed from an issue, you can leave a comment to ask questions about it. If you have an idea for a solution, but want to run it past the project team before starting, work, you can leave a comment for that too. Issues are a good place for open discussions like this. + + +**Working on an issue** + +When beginning work on an issue locally, the first thing you’ll need to do is to create a branch for that piece of work. There are many Git UI tools that allow you to create a branch, for this demo we’ll use the command line. To create and checkout a branch you can use a single command. + +``` +git checkout -b +``` + +This command allows us to specify a name for our new branch and immediately check it out so we can work on it. It's common to name the branch with the issue number. For example if we are working on the issue #223, it would be a good idea to name the branch, + + +``` +git checkout -b 223 +``` + +Once we are on our new branch we can make changes to the code which addresses the issue. When we have made the required changes that address a particular issue, we need to commit that code to our branch. We can use the “git status” command to view the changes since our last commit. + +``` +git status +``` + +We then use the “git add” command to stage the changes for the next commit. It's possible to add the files one by one by specifying their relative path afterward. For example, if we want to add the corrections.js file in the same directory, + +``` +git add corrections.js +``` + +However, if you want to stage all the files that have been changed, it's also possible with the following command. +``` +git add * +``` +Next, we will commit our staged changes using the “git commit” command. In this case we can use the following example: +``` +git commit -m "Fix readme typo" +``` + +The -m option allows us to specify a message for our commit. It’s good practice to try and provide a succinct, but descriptive message for your commits. This helps a reviewer understand at a high level what was addressed in each commit. + +At this point, we have made and committed out changes local to our development machine. Our final step is to push the changes to our fork of the master repository up on GitHub. We can do that using the “git push” command. We need to specify the name of the remote that we want to push to and the name of the branch we want to push up. + ``` + git push origin 223 + ``` + +Now the changes we have made are pushed into our fork in GitHub. The final step is to make a pull request. A **pull request** (PR) is a method of submitting contributions to an open development project. It occurs when a developer asks for changes committed to an external repository to be considered for inclusion in a project's main repository after the peer review. + +In order to make a pull request, visit the forked repository on GitHub. On the top right hand side a button will now be there mentioning that a pull request is ready to be made. + +![enter image description here](https://i.imgur.com/bTN9On5.jpg) +Click on the "compare and pull request" button to make the pul request! diff --git a/donut-docs/donut-documentation/donut-frontend/design.md b/donut-docs/donut-documentation/donut-frontend/design.md new file mode 100644 index 0000000..c565a1e --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/design.md @@ -0,0 +1,23 @@ +# Design + +User interface is created mainly using Bootsrap. However in the near future styling will be moved to the react material ui framework. + +## Sign Up page + +![enter image description here](https://image.prntscr.com/image/E98J06eYSU_lAryPogLdDw.png) + +## Login page + +![enter image description here](https://image.prntscr.com/image/_TbBhIylRQm7oLpZY8TT6A.png) + +## Dashboard page + +![enter image description here](https://image.prntscr.com/image/-bfVNQCORruJrsYxZjrkWA.png) + +## Pinned Posts + +![enter image description here](https://image.prntscr.com/image/VUl5DsX8RnitJHepLHJX1g.png) + +## Profile as viewed by ourselves + +![enter image description here](https://image.prntscr.com/image/LbYQQ9znQ-_pas0xJUeEhw.png) diff --git a/donut-docs/donut-documentation/donut-frontend/setting-up-the-work-environment.md b/donut-docs/donut-documentation/donut-frontend/setting-up-the-work-environment.md new file mode 100644 index 0000000..bfb3b67 --- /dev/null +++ b/donut-docs/donut-documentation/donut-frontend/setting-up-the-work-environment.md @@ -0,0 +1,31 @@ +# Setting up the work environment. + +Few things are required before setting up the project locally, + + - **A Web Browser** - You can install any browser as per your preference e.g. Internet Explorer,Chrome, FireFox, Safari, Opera etc. JavaScript works on any web browser on any OS. + - **An Editor**- We prefer an editor which has built-in features of IntelliSense support and syntax error highlighter for speedy development. Download Visual Studio Code from [here](https://code.visualstudio.com/download). + - **Node and Node Package Manager(NPM)** + Check if node and npm are already installed by running the following commands in the terminal + ``` + node -v + npm -v + ``` +If not install it in, + - **Windows & MacOS** + + Installing Node and NPM on Windows and macOS is straightforward because you can just use the provided installer: + Go to https://nodejs.org/en/ + Select the button to download the LTS build that is "Recommended for most users". + Install Node by double-clicking on the downloaded file and following the installation prompts. + + - **Ubuntu** + The easiest way to install the most recent LTS version of Node 10.x is to use the [package manager](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions) to get it from the Ubuntu _binary distributions_ repository. This can be done very simply by running the following two commands on your terminal: + ``` + curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - + sudo apt-get install -y nodejs + ``` + + + + + diff --git a/internship/codeuiners/README.md b/internship/codeuiners/README.md new file mode 100644 index 0000000..38f4da7 --- /dev/null +++ b/internship/codeuiners/README.md @@ -0,0 +1,14 @@ +--- +description: >- + This page displays information about students who have got opportunity to + intern with CodeUino. +--- + +# Codeuiners + +{% page-ref page="ayush-nagar.md" %} + +{% page-ref page="devansh-agrawal.md" %} + + + diff --git a/internship/codeuiners/ayush-nagar.md b/internship/codeuiners/ayush-nagar.md new file mode 100644 index 0000000..dd27cb7 --- /dev/null +++ b/internship/codeuiners/ayush-nagar.md @@ -0,0 +1,52 @@ +--- +description: >- + Short Intro: I am Ayush Nagar, a pre-final year student at JIIT, Noida. I am + Full stack web developer with keen interest in Deep Learning and pyrhon. +--- + +# Ayush Nagar + +![](../../.gitbook/assets/ayush%20%281%29.jpg) + +### Profiles: Ayush Nagar + +### Project Name: Codebadge Project + +### Project Deliverables: + +Trello board: [https://trello.com/b/gTvUZSuP/codeuino-internship-program](https://trello.com/b/gTvUZSuP/codeuino-internship-program) + +### Blogs: + +{% tabs %} +{% tab title="Scrum" %} +Project Report: [https://docs.google.com/document/d/189pmvPWYcc6NBjXh5PUs5LUpgdDYKGnaL0Jty\_4fQ1U/edit?usp=sharing](https://docs.google.com/document/d/189pmvPWYcc6NBjXh5PUs5LUpgdDYKGnaL0Jty_4fQ1U/edit?usp=sharing) + +Week 1: [https://docs.google.com/document/d/1ItThcoctC71sKMFqlikqt76je6kqFxVxV\_OKtC4nkMw/edit?usp=sharing](https://docs.google.com/document/d/1ItThcoctC71sKMFqlikqt76je6kqFxVxV_OKtC4nkMw/edit?usp=sharing) + +Week 2: [https://docs.google.com/document/d/1iFlUWJ12dvPaFx-1IuVOaP4ulMLkOd7UuE-azlmxBBk/edit?usp=sharing](https://docs.google.com/document/d/1iFlUWJ12dvPaFx-1IuVOaP4ulMLkOd7UuE-azlmxBBk/edit?usp=sharing) + +Week 3: [https://docs.google.com/document/d/1Ls6634QTUtvv2pLbgfXPjOuvl6amKV05ll3NFcxxQxw/edit?usp=sharing](https://docs.google.com/document/d/1Ls6634QTUtvv2pLbgfXPjOuvl6amKV05ll3NFcxxQxw/edit?usp=sharing) +{% endtab %} + +{% tab title="Blogs Posts" %} +Week 1: [https://medium.com/@an431999/summer-intern-under-codeuino-week-1-may-18th-may24th-ef1b5b10434e](https://medium.com/@an431999/summer-intern-under-codeuino-week-1-may-18th-may24th-ef1b5b10434e) + +Week 2: [https://medium.com/@an431999/summer-intern-under-codeuino-week-2-may-25th-may-31st-646e3c78f0bf](https://medium.com/@an431999/summer-intern-under-codeuino-week-2-may-25th-may-31st-646e3c78f0bf) + +Week 3: [https://medium.com/@an431999/summer-intern-under-codeuino-week-3-june-1st-june-7th-b7c0bc32102d](https://medium.com/@an431999/summer-intern-under-codeuino-week-3-june-1st-june-7th-b7c0bc32102d) + +Codebadge: revamp: [https://medium.com/@an431999/codebagde-project-revamp-480944797c4b](https://medium.com/@an431999/codebagde-project-revamp-480944797c4b) +{% endtab %} + +{% tab title="Screen Recordings" %} +Week 2: [https://drive.google.com/file/d/1Q-SnGvOpvg3CR3fwYUD\_QCw\_LGfPhEiL/view?usp=sharing](https://drive.google.com/file/d/1Q-SnGvOpvg3CR3fwYUD_QCw_LGfPhEiL/view?usp=sharing) + +Week 3: [https://drive.google.com/file/d/1I3qGWsjpr3KbP8JqZjSSa5\_TjewubSAC/view](https://drive.google.com/file/d/1I3qGWsjpr3KbP8JqZjSSa5_TjewubSAC/view) +{% endtab %} +{% endtabs %} + + + + + diff --git a/internship/codeuiners/devansh-agrawal.md b/internship/codeuiners/devansh-agrawal.md new file mode 100644 index 0000000..2d99825 --- /dev/null +++ b/internship/codeuiners/devansh-agrawal.md @@ -0,0 +1,10 @@ +--- +description: 'Short Intro:' +--- + +# Devansh Agrawal + +![](../../.gitbook/assets/devansh.jpg) + +Dummy Content + diff --git a/meetings-notes.md b/meetings-notes.md new file mode 100644 index 0000000..c18b4a9 --- /dev/null +++ b/meetings-notes.md @@ -0,0 +1,72 @@ +# Meetings Notes + +#### Google Summer of Code 2020 + +* **GSoC Meet-1:** [**05-05-2020**](https://docs.google.com/document/d/1rnY-z7bEv0TYbp4Bm4QNd9Hcq6PgxRdAXmk4zoRetcE/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-2:** [**07-05-2020**](https://docs.google.com/document/d/1UxqU_vh-dU11pmv332RnY2P7Lc4S3kP_EUZwV4LWrrg/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-3:** [**11-05-2020**](https://docs.google.com/document/d/1siis9syPABD7-GqGPOXkc08lUrjjYzyGlHRWfK-8mFo/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-4:** [**14-05-2020**](https://docs.google.com/document/d/1CB2OdnMcfABPvcusQOjpLjOIaGWG_9FINEVCjlANbrA/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-5:** [**18-05-2020**](https://docs.google.com/document/d/1s286UOFG0z44U-TCmvsnP3oT0Z7kHB0HOjwMjAGTG3I/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-6:** [**21-05-2020**](https://docs.google.com/document/d/1NHXaGQqV89jIN5sIzPxkukNneUVgWXlViMCRhLk4Ob8/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-7:** [**25-05-2020**](https://docs.google.com/document/d/16uHAxk-NrBrnFKgPYN9XnyjqA84-YoFUn87JfOi9wPc/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-8:** [**28-05-2020**](https://docs.google.com/document/d/1c5q77mP2vPMeKP67J-dWOduIJs1MYLSumXmM-8CkgXs/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-9:** [**01-06-2020**](https://docs.google.com/document/d/1dxaz6Uq__6uekD62F8PfMPTiXPbVwO34Vof3wJ_liBQ/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-10:** [**04-06-2020**](https://docs.google.com/document/d/1na6X4TI4uW9N4jgQlx6O1TcskXmmYUEni9Dv8bjAFJk/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-11:** [**08-06-2020**](https://docs.google.com/document/d/1hwwESyy8Fd-w-CuhtXa3fLrjBkWgYp5NOUYohzrpWbo/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-12:** [**11-06-2020**](https://docs.google.com/document/d/1P0zLIT2RmmuiEUPTv2gy3niemshWni4XVba2EFlzs34/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-13:** [**15-06-2020**](https://docs.google.com/document/d/17wP1P0EJo5IUaEUd6DLAsMApxLW-x9C2gykE5G0uhL4/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-14:** [**18-06-2020**](https://docs.google.com/document/d/1Xe6yKvEl91Fc8Fj4bH7Ph1TUunaHI1ZmrQKCWqD7H3g/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-15:** [**22-06-2020**](https://docs.google.com/document/d/1h2phM9e7kPLjLgdrGswTAemo9cSwq2YuDEw_9mN3fTk/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-16:** [**25-06-2020**](https://docs.google.com/document/d/1ZZ7kGJp9B3TU7kCA8a1sldqYqNj20MXqPR1Asfeo3nk/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-17:** [**29-06-2020**](https://docs.google.com/document/d/1WBUVmVzUvlIMW5Kn09Uh0t5n1b9fc46Yd7okOsWHiOE/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-18:** [**02-07-2020**](https://docs.google.com/document/d/1HKTXUKwvNYg6t5z96ffFZlltOSc417PDo_cRca6qT9k/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-19:** [**06-07-2020**](https://docs.google.com/document/d/1LcKbd-XbJZn60dj5gOJm84DP_fvpMKg9-mXz33w5ye8/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-20:** [**13-07-2020**](https://docs.google.com/document/d/1Au-sFHYQBYdK5WDCjHJmrSTC86DyE4rv4UPyG0ROJ2Y/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-21:** [**16-07-2020**](https://docs.google.com/document/d/1i4b_QRcPs6MDRKv7QtiWv79tZqs9Z0W47Yr_4lhRtk8/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-22:** [**20-07-2020**](https://docs.google.com/document/d/1WHWjGQOO4GK4IkIpU8rNZK5c94JWptIvsFkVROC5_OU/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-23:** [**23-07-2020**](https://docs.google.com/document/d/1QAXlAnDwAV12SpaGoo9B-_depFrf20P0tRb6SKecvLw/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-24:** [**27-07-2020**](https://docs.google.com/document/d/1__xocyfQONUKQqYczEo4W8vML6V3Mtp4YqUP4kHuXPk/edit?usp=sharing) +* **GSoC Meet-25:** [**30-07-2020**](https://docs.google.com/document/d/15nVxtuXNrqnVtDGh_xUk6npIRALoqDEV_-HMUvd3OTY/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-26:** [**03-08-2020**](https://docs.google.com/document/d/1dsjlGvtHzPwlmdHVaMQvXOQS2r3zjPK_YHNOCyIywA0/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-27:** [**06-08-2020**](https://docs.google.com/document/d/1MRMmUR--55tn5LVLoi_xuZ0F-1pF91qFCaLzQG22ZZU/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-28:** [**10-08-2020**](https://docs.google.com/document/d/1cq46htX-VfA94PAvezRltvwE3cJkTbx9jUJxbCb9NNw/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-29:** [**13-08-2020**](https://docs.google.com/document/d/1TgNFmnrvycLXXMcn_1oZ5ckx0bTOtniuEvtSyhVSLZo/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-30:** [**17-08-2020**](https://docs.google.com/document/d/1lYEMB18Yyp2LgT_WhJKufdog3pPmoDN9xHC6-M7W5QE/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-31:** [**21-08-2020**](https://docs.google.com/document/d/1bOaZxObeq4525sN68iJTpXLGeai12-KZstbEQDqhFwQ/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-32:** [**24-08-2020**](https://docs.google.com/document/d/1HiuLGLAb4hxK84BUkhjZxf9wWjxGoZshIehW8ag0Zfo/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-33:**[ **27-08-2020**](https://docs.google.com/document/d/1Px6s3PqF_rE816JE3E-m69H4_7FtT6ujxAh9k8UkTGw/edit?usp=sharing)\*\*\*\* +* **GSoC Meet-34:** [**31-08-2020**](https://docs.google.com/document/d/1pUy59QsUuYerAX3MWUJW1LxSeTGR6YGpc6WsAjND8u4/edit?usp=sharing)\*\*\*\* + +**Linux Foundation CommunityBridge Mentorship Program Meetings:** + +* **LF Meet-1:** [**03-09-2020**](https://docs.google.com/document/d/1pUy59QsUuYerAX3MWUJW1LxSeTGR6YGpc6WsAjND8u4/edit?usp=sharing)\*\*\*\* +* **LF Meet-2:** [**07-09-2020**](https://docs.google.com/document/d/1wjBkBwsxtHV1D626EKz3OnKb1snD0EtW4yVqIAjdACY/edit?usp=sharing)\*\*\*\* +* **LF Meet-3:** [**10-09-2020**](https://docs.google.com/document/d/17b5Yx0qd1VKWDxtv1kr-A78X4IgXCok5x9oTn7utmeY/edit?usp=sharing)\*\*\*\* +* **LF Meet-4:** [**14-09-2020**](https://docs.google.com/document/d/1A51-z2fyiHe5aOCYmE2FENIMlWBD5L3dO_AwvRtBgvI/edit?usp=sharing)\*\*\*\* +* **LF Meet-5:** [**21-09-2020**](https://docs.google.com/document/d/1oQPiJy-FPenJtKDsmLG1is8NjElXT3GhQuqMlxd2J4Q/edit?usp=sharing)\*\*\*\* +* **LF Meet-6:** [**24-09-2020**](https://docs.google.com/document/d/19hWFu5UHg-qrafWflEqxS9yJ6du8Xv_RSnyjQvl3CTY/edit)\*\*\*\* +* **LF Meet-7:** [**01-10-2020**](https://docs.google.com/document/d/1GE4bVB81jE5Srw4lkxwtC15hjs_a6Eksn25tPNaNuNo/edit?usp=sharing)\*\*\*\* +* **LF Meet-8:** [**05-10-2020**](https://docs.google.com/document/d/1LGEjbkGl90SqxvunRv8I9HbNONfUGLb0mvU4ZoIZ0kI/edit?usp=sharing)\*\*\*\* +* **LF Meet-9:** [**08-10-2020**](https://docs.google.com/document/d/1in7Rkcje8rGV0kBk4DckCN2zg-q8y-680zWsrqJDPdU/edit?usp=sharing)\*\*\*\* +* **LF Meet-10:** [**12-10-2020**](https://docs.google.com/document/d/1NKz9DfkdHaH-miWK4LF10OSC-tV-TZ76aPTmLiuygV0/edit?usp=sharing)\*\*\*\* +* **LF Meet-11:** [**15-10-2020**](https://docs.google.com/document/d/1tXN2fppod35Viq_8UMJhHUK5xt-jrB7he57eznH4kYE/edit?usp=sharing)\*\*\*\* +* **LF Meet-12** +* **LF Meet-13:** [**22-10-2020**](https://docs.google.com/document/d/1dEq12dL1XyCjFwUpkl2DvStcyxTcfaJFExAoEf-uvaI/edit?usp=sharing)\*\*\*\* +* **LF Meet-14:** [**26-10-2020**](https://docs.google.com/document/d/1H7Z__TSAVegORNP6i1ZN90zJZCTHngXuv9R7Rw9airw/edit?usp=sharing)\*\*\*\* +* **LF Meet-15:** [**29-10-2020**](https://docs.google.com/document/d/10O7pNeri97CHZPSRkgWaHgXDsyGknvb7pJHCSGdWUPU/edit?usp=sharing)\*\*\*\* +* **LF Meet-16:** [**02-11-2020**](https://docs.google.com/document/d/1BoBIVTZU3FOqV8oYsbUnV9PMfBysDar_yjtwPp-Ygmk/edit?usp=sharing)\*\*\*\* +* **LF Meet-17:** [**05-11-2020**](https://docs.google.com/document/d/1UsmpqAcXEdJT-sxFhPyR_WeZAfnNw3DrNtnmY0bOSN0/edit?usp=sharing)\*\*\*\* +* **LF Meet-18:** [**09-11-2020**](https://docs.google.com/document/d/1UsmpqAcXEdJT-sxFhPyR_WeZAfnNw3DrNtnmY0bOSN0/edit?usp=sharing)\*\*\*\* +* **LF Meet-19:** +* **LF Meet-20:** [**19-11-2020**](https://docs.google.com/document/d/1IhelXiZUZU32MGNHqILCxZZb5_VHY7bPpy52LhN-_zg/edit?usp=sharing)\*\*\*\* +* **LF Meet-20:** [**23-11-2020**](https://docs.google.com/document/d/109f6uL7Gr7DH2baczDQxFDeN0dEJoFKLw0EP0LgLiqU/edit?usp=sharing)\*\*\*\* +* **LF Meet-21:** [**30-11-2020**](https://docs.google.com/document/d/1BoBIVTZU3FOqV8oYsbUnV9PMfBysDar_yjtwPp-Ygmk/edit?usp=sharing)\*\*\*\* +* **LF Meet-22:** [**03-12-2020**](https://docs.google.com/document/d/1MA3UPxw6OnV05tVr_QWkZYEMvCGjQ50yFiAayI3QJKM/edit?usp=sharing)\*\*\*\* +* **LF Meet-23:** [**07-12-2020**](https://docs.google.com/document/d/1O4JnLeQ3fv7OG1YxxMzLcQG7zhhozbwDy_3hYHbHkyM/edit?usp=sharing)\*\*\*\* +* **LF Meet-24:** [**10-12-2020**](https://docs.google.com/document/d/1LBPhZep7JDj8Uz-DRR8YH1-PodFSb2Ef-rr72y74xSk/edit?usp=sharing)\*\*\*\* +* **LF Meet-25:**[**14-12-2020**](https://docs.google.com/document/d/1jAsAhpTKaekYpoHovRATDSCK2CRn8qMsJ0hG7dr77zg/edit?usp=sharing)\*\*\*\* +* **LF Meet-26:** [**21-12-2020**](https://docs.google.com/document/d/1Gn3dnCiDdxADzEbP8MBAhzXLnyoF7pRIN00uv0d3uko/edit?usp=sharing)\*\*\*\* +* **LF Meet-27:** [**24-12-2020**](https://docs.google.com/document/d/13Go-1kW2wQBpzfB_LPtjSjl3-B-CK1qq9w_xubdRBfU/edit?usp=sharing)\*\*\*\* + + + diff --git a/our-values.md b/our-values.md new file mode 100644 index 0000000..266f618 --- /dev/null +++ b/our-values.md @@ -0,0 +1,46 @@ +# Our Values + +Just like the rest of our work, we continually adjust our values and strive to make them better. The Codeuino community values are a living document. In many instances, they have been documented, refined, and revised based on lessons learned in the course of working effectively and efficiently. + +So this section is our core which reflects **how we organize ourselves**, **community guidelines**, **community ethics**, all the way down to **how we remunerate ourselves**! + +Everyone is welcome to suggest improvements. + +**The Codeuino community** is a value-driven organization and here is what we believed in: + +### 🌱 **Sustainability:** + +Our mission is focused on creating open sustainability within social networking and build OSS/FOSS social-environmental tools with a sole motive to benefit organizations and individuals to have a common platform for collaboration. What we really mean by the “sustainable” codeuino's project is where the core contributors have a _sustainable interest_ in keeping the project going, getting others to use it, helping it to be maintained at a certain level, responding to bug reports, developing new innovations and so forth. We can’t achieve our mission unless we are sustainable in doing it. We take a broad definition of sustainability as social networking, community health, and individual sustainability in the collaboration. + +### 🤝 Collaboration: + +Helping others is our priority, even when it is not immediately related to the goals that you are trying to achieve. Similarly, you can rely on others for help and advice—in fact, you're expected to do so. Anyone can chime in on any subject, including people who don't work at Codeuino. The person who's responsible for the work decides how to do it, but they should always take each suggestion seriously and try to respond and explain why it may or may not have been implemented. + +### \*\*\*\*👐 **Openness:** + +Openness is the key to any open source project. Work within the Codeuino community is primarily organized around social networking. ****So following through the definition of the openness The Codeuino community is dedicated to fostering an open and welcoming environment for contributors. For starters, we provide the same level of source code available to all developers, meaning there is no favoritism to developers via priority access. Anyone can join the mailing list, participate in video conferencing meetings, or contribute to any of our projects on GitHub at any time! _We strive to be open!_ + +We encourage contributions through the visible recognition of the contributors and the provision of a transparent contribution and acceptance process that provides clear feedback on updates to contributions as they are incorporated into the project. + +### 👁 **Transparency:** + +Being transparent about as many things as possible is an aim for the open source ecosystem. By making information public, we reduce the threshold to contribution and make collaboration easier. We appreciate the use of public issue trackers, projects, and repositories on GitHub when possible. + +We make information public by default because transparency is one of our values. However, it is most important to focus on better and healthy outcomes Therefore, a category of information is **public** unless there is a reason for it not to be. We have meetings every week and we welcome everyone, who is not only within the core team but also who has keen interests to participate and support our structure. + +When information is not public, it may also be treated as limited access, only shared with certain Codeuino community members. + + Transparency creates awareness for Codeuino community, allows us to recruit people that care about our values, gets us more and faster feedback from people outside the company, and makes it easier to collaborate with them. It is also about sharing great software, documentation, examples, lessons, and processes with the **whole community** and the world in the spirit of open source, which we believe creates more value than it captures. + +### ⏰ Efficiency: + + We care about working on the right things, not doing more than needed, and not duplicating work. This enables us to achieve more progress, which makes our work more fulfilling. + +### 🌐 Diversity, Inclusion & Belonging + + Diversity, inclusion, and belonging are fundamental to the success of the Codeuino community. We aim to make a significant impact on our efforts to foster an environment where everyone can thrive. We have designed a multidimensional approach to ensure that Codeuino community is a place where people from every background and circumstance feel like they belong and can contribute. We actively chose to build and institutionalize a culture that is inclusive and supports all team members equally in the process of achieving their professional goals. We have people participating in our community calls globally and we encourage participation in a diverse set of countries. We work to make everyone feel welcome and to increase the participation of underrepresented minorities and nationalities in our community and company. + +### Consistency: + +Being consistent with our day job helps us to stay motivated and encouraged. We are consistent with maintaining and building the open source sustainable and social networking products that help other external projects and communities to use it a better way. We are dependable, reliable, and responsible for our decisions and actions every single day. From our delivery and management teams to the service we provide our customers, consistency throughout the entire operation is paramount to our success. + diff --git a/outreach.md b/outreach.md new file mode 100644 index 0000000..41795c1 --- /dev/null +++ b/outreach.md @@ -0,0 +1,23 @@ +# Outreach + +We are an open-source social networking organization and it fulfills our social needs to interact with the social maintainers and other individuals who can help us grow. + +Spreading the word about what is going on in the Codeuino community is a vital part of Codeuino engagement, and below are the following ways with which you can get involved in growing the Codeuino community + +#### Writing Blog Posts + +Some documentation is barely readable and needs proofreading for grammar, spelling, and sentence construction corrections. This helps the overall implementation and evolution of a project. In other cases, the documentation describes technical details but lacks any information for beginners. Plus, outlier cases, workarounds, and best practices should be written down and included. You can help in spreading the mission and vision of the Codeuino community. We have the [**Codeuino publication account on medium**](https://medium.com/codeuino) but feel free to write blog posts of Codeuino on either platform + +#### Social Media + +You can help us spread the word by sharing about Codeuino on social handles. The Codeuino has its account on Twitter and you can tag with the username as @codeuino By this, you can take into the responsibility of handling all the Codeuino's social handles. + +#### Organize Meetups and Events + +if you are good at organizing and managing the events, then you can help us organise the Codeuino events. For this, we prefer to have a document that lays down all the requirements and goals for any event which later needs to be approved by the Codeuino board + +#### Get Sponsorship + +We are a growing community and everyone inside it contributes voluntarily towards the betterment of the projects. We need various kinds of sponsorship to fulfill our social needs and avail the best resources to run our projects. +You can help us in reaching out to the companies, communities, and individuals who can help us support the projects. All our funds are hosted on the **Linux Foundation Funding Platform.** So you can ask to contribute directly on the [**Linux Foundation CommunityBridge Funding Platform**](https://funding.communitybridge.org/projects/f88b09ee-432d-4714-ad09-304b7a24e1e6)\*\*\*\* + diff --git a/path-to-leadership.md b/path-to-leadership.md new file mode 100644 index 0000000..c8b0cc3 --- /dev/null +++ b/path-to-leadership.md @@ -0,0 +1,48 @@ +# Path to Leadership + +> I believe that true mark of a leader is the willingness to stick with a bold course of action — an unconventional working strategy, a unique product-development roadmap, innovation to better productivity, and planning to outreach +> +> -- [**Jaskirat Singh**](https://twitter.com/jaskirat626)**, Founder of Codeuino** + +### What does leadership inside the Codeuino mean? + +A leader is someone who can help in the creation, planning, and grooming of the things inside the community alongside establishing a flow to help other contributors easily take work in process. + +### Importance of Leadership to us + +The open-source culture is collaborative, contributing upstream is only the first step in shaping an open-source project’s progression. Taking an active role in guiding or influencing the project’s direction is critically essential as it helps us to refine our boundaries for a better outcome. We need someone to direct the vision of creation, planning, and architecture of our social networking objectives + +#### Requirements for being the Repo Maintainers + +Maintainers are members of the repository's Write Access Team\(s\), and exercise a range of editorial responsibilities to keep the community focused upon key development goals, keep repository assets clearly identified and organized, and help keep conversations on the topic. + +* Being able to operate a bug tracker +* Holds the knowledge of the Git and GitHub +* Understand the workflows of the Issues, Pull Requests, and Merge Conflicts, +* Had been a consistent contributor of the respective project producing relevant content and contribution +* Have good communication and writing skills +* Follow best practices while writing code, and unit tests +* Attend meetings + +**Requirements for being the Documentation Maintainers** + +Documentation Maintainers are responsible for prepare instruction manuals and articles with the main goal to communicate complex, technical information more easily. They also develop, gather, and disseminate technical information among customers, designers, and manufacturers. + +* Good writing and communication skills in English +* Analyze functional and technical specifications of projects +* Holds critical thinking and problem-solving skills +* Has contributed previously towards the documentation + +#### Requirements for being the Board of Director position + + A **board of directors** is a group of people who jointly supervise the activities of an organization + +* Consistent contributor towards the Codeuino community +* Proven industry experience in a similar managerial position +* Holds good communication skills +* Has produced valuable content within the community in the past +* Holds a good knowledge of strategic and problem thinking +* Regular with the community meetings +* Responsive in terms of providing feedback, suggestions, new strategic ideas and helping other community people +* Holds the knowledge of performance evaluation and decision-taking + diff --git a/codebadge/codebadge-documentation/README.md b/projects/codebadge/README.md similarity index 64% rename from codebadge/codebadge-documentation/README.md rename to projects/codebadge/README.md index aa9922f..5957859 100644 --- a/codebadge/codebadge-documentation/README.md +++ b/projects/codebadge/README.md @@ -1,4 +1,8 @@ -# Codebadge Documentation +# Codebadge + +## About Codebadge + +{% page-ref page="about-codebadege.md" %} ## Codebadge Frontend diff --git a/projects/codebadge/about-codebadege.md b/projects/codebadge/about-codebadege.md new file mode 100644 index 0000000..e1d1608 --- /dev/null +++ b/projects/codebadge/about-codebadege.md @@ -0,0 +1,2 @@ +# About Codebadege + diff --git a/codebadge/codebadge-documentation/codebadge-backend.md b/projects/codebadge/codebadge-backend.md similarity index 100% rename from codebadge/codebadge-documentation/codebadge-backend.md rename to projects/codebadge/codebadge-backend.md diff --git a/codebadge/codebadge-documentation/codebadge-frontend.md b/projects/codebadge/codebadge-frontend.md similarity index 100% rename from codebadge/codebadge-documentation/codebadge-frontend.md rename to projects/codebadge/codebadge-frontend.md diff --git a/donut-docs/donut-documentation/README.md b/projects/social-platform-donut/README.md similarity index 55% rename from donut-docs/donut-documentation/README.md rename to projects/social-platform-donut/README.md index e27f254..b4df7a7 100644 --- a/donut-docs/donut-documentation/README.md +++ b/projects/social-platform-donut/README.md @@ -1,4 +1,8 @@ -# Donut Documentation +# Donut - Social Platform + +## About Donut + +{% page-ref page="about-donut.md" %} ## Donut Frontend @@ -12,3 +16,9 @@ {% page-ref page="donut-design-guidelines/" %} +## Donut Database Schema + +{% page-ref page="donut-database-schema.md" %} + + + diff --git a/projects/social-platform-donut/about-donut.md b/projects/social-platform-donut/about-donut.md new file mode 100644 index 0000000..4d2225a --- /dev/null +++ b/projects/social-platform-donut/about-donut.md @@ -0,0 +1,2 @@ +# About Donut + diff --git a/donut-docs/donut-documentation/donut-backend/README.md b/projects/social-platform-donut/donut-backend/README.md similarity index 100% rename from donut-docs/donut-documentation/donut-backend/README.md rename to projects/social-platform-donut/donut-backend/README.md diff --git a/donut-docs/donut-documentation/donut-backend/about.md b/projects/social-platform-donut/donut-backend/about.md similarity index 100% rename from donut-docs/donut-documentation/donut-backend/about.md rename to projects/social-platform-donut/donut-backend/about.md diff --git a/donut-docs/donut-documentation/donut-backend/client-side.md b/projects/social-platform-donut/donut-backend/client-side.md similarity index 100% rename from donut-docs/donut-documentation/donut-backend/client-side.md rename to projects/social-platform-donut/donut-backend/client-side.md diff --git a/donut-docs/donut-documentation/donut-backend/contributors-guide.md b/projects/social-platform-donut/donut-backend/contributors-guide.md similarity index 100% rename from donut-docs/donut-documentation/donut-backend/contributors-guide.md rename to projects/social-platform-donut/donut-backend/contributors-guide.md diff --git a/donut-docs/donut-documentation/donut-backend/installation.md b/projects/social-platform-donut/donut-backend/installation.md similarity index 100% rename from donut-docs/donut-documentation/donut-backend/installation.md rename to projects/social-platform-donut/donut-backend/installation.md diff --git a/donut-docs/donut-documentation/donut-backend/server-side.md b/projects/social-platform-donut/donut-backend/server-side.md similarity index 100% rename from donut-docs/donut-documentation/donut-backend/server-side.md rename to projects/social-platform-donut/donut-backend/server-side.md diff --git a/projects/social-platform-donut/donut-database-schema.md b/projects/social-platform-donut/donut-database-schema.md new file mode 100644 index 0000000..ebd6479 --- /dev/null +++ b/projects/social-platform-donut/donut-database-schema.md @@ -0,0 +1,10 @@ +--- +description: This database schema is not 100% perfect +--- + +# Donut Database Schema + +{% file src="../../.gitbook/assets/donut-documentation.pdf" caption="donut\_db\_schema" %} + + + diff --git a/donut-docs/donut-documentation/donut-design-guidelines/README.md b/projects/social-platform-donut/donut-design-guidelines/README.md similarity index 100% rename from donut-docs/donut-documentation/donut-design-guidelines/README.md rename to projects/social-platform-donut/donut-design-guidelines/README.md diff --git a/projects/social-platform-donut/donut-design-guidelines/brand-visual-guide.md b/projects/social-platform-donut/donut-design-guidelines/brand-visual-guide.md new file mode 100644 index 0000000..6edb4d7 --- /dev/null +++ b/projects/social-platform-donut/donut-design-guidelines/brand-visual-guide.md @@ -0,0 +1,21 @@ +# Brand Visual Guide + +### Introduction + +This document will guide you through the basic visual communications developed for the Donut platform's brand identity. It serves as a collection of visual components and rules to convey a range of expressions. + +Donut’s identity is formed by the brandmark, color, typography and composition. Together, this system of core elements creates a consistent visual language for the platform. + + +### BrandMark + +**Primary Brandmark** + +![](../../../.gitbook/assets/primary-brandmark.jpg) + +**Symbol** + +![](../../../.gitbook/assets/brandmark.jpg) + + + diff --git a/donut-docs/donut-documentation/donut-frontend.md b/projects/social-platform-donut/donut-frontend.md similarity index 100% rename from donut-docs/donut-documentation/donut-frontend.md rename to projects/social-platform-donut/donut-frontend.md diff --git a/projects/social-platform-donut/ideas.md b/projects/social-platform-donut/ideas.md new file mode 100644 index 0000000..e73515c --- /dev/null +++ b/projects/social-platform-donut/ideas.md @@ -0,0 +1,28 @@ +# Ideas + +DONUT: + +* [ ] Covert existing codebase according to OOP paradigm. +* [ ] Building log mechanism for Donut. +* [ ] Making Donut responsive on majority platforms\(mobile/tables/desktop\) +* [ ] Redis Layer +* [ ] Having queue mechanism for writing to DB. +* [ ] Image compression and storage using AWS +* [ ] Mobile app - \(React Native\) +* [ ] API versioning +* [ ] Dark Theme +* [ ] Loading animation - proper implementation +* [ ] OTP -> phone/email -> twilio +* [ ] Deploying Donut just like Discourse +* [ ] API status page ex: [https://www.githubstatus.com/](https://www.githubstatus.com/) +* [ ] WIKI page in Donut +* [ ] BOTs - Poll, announcements, praising, welcome +* [ ] Making a support Ticket in order to talk to admins and between other communities memebers +* [ ] +FORUM: + +* [ ] Making Donut responsive on majority platforms\(mobile/tables/desktop\) +* [ ] Mobile app - \(React Native\) + + + diff --git a/role-and-responsibilities.md b/role-and-responsibilities.md new file mode 100644 index 0000000..d75e88c --- /dev/null +++ b/role-and-responsibilities.md @@ -0,0 +1,16 @@ +# Role and Responsibilities + +### Repository Maintainer + +* Preparing, Leading, and maintaining the meetings with meeting notes +* Facilitate the creation and advancement of the projects +* Answering the questions for the specific repository on the communication channels, Github issues, and meetings +* Coordinate with other maintainers +* Explaining the things in detail on the issues and pull requests +* Review issues on the repository +* Review and merge pull requests +* Regularly check the repository for stale content +* Monitor issue tracker and pull requests +* Steer the architecture of the project +* Keeping the repository updated +