[Bobrandy13] Created Contributions Page#83
Merged
Conversation
Contributor
|
Need help here -> |
Contributor
Author
|
Hm, I not sure but I had a look online. |
Owner
|
I've done a pretty thorough search and I can't find another other OSS projects which have similar layouts. Not sure on a good layout to show user info and also contain a list of contributions they've done. But I personally think a card may not be enough data / be too minimal for the page. Not sure on the actionables here yet, but if you're able to find other examples of OSS projects with websites showing their contributors for inspiration or an excalidraw wireframe of some proposed UI/UX ideas that be great. Until then I'll be keeping this one in the backlog as I'm not sure a good way to handle this ticket. Closest I found was this standard https://github.com/all-contributors/all-contributors which contributes all contributors and categories them into:
We could do like tabs for the main ones i.e. Dev, Documentation, Templates, Bug Reports and then show cards / a row with their name, contribution, and what they did / link PRS / a github card like this:
And then some comments like MathPow:
For example. Just open to ideas on a good way to implement this. I do like the idea / feature, as mentioned in #72 |
ShaanCoding
changed the title
Owner
|
Mentioned specs in #72 |
Contributor
Author
|
oops mb team |
bobrandy13
force-pushed
the
contributions_page
branch
from
9cd5757 to
1352939
Compare
bobrandy13
commented
May 11, 2024
| @@ -0,0 +1,54 @@ | |||
| export default function contributions() { | |||
| // TODO: returns a list of contributions dynammically fetched from GITHUB | |||
Contributor
Author
There was a problem hiding this comment.
oops this file shouldnt be here.
Should hopefully be a working contributions page
ShaanCoding
force-pushed
the
contributions_page
branch
from
f3036ad to
c6167a9
Compare
- Moved from team to contributors as the URL - Added the route to header & footer, instead of only footer and updated the name from "Team" to "Contributors" as this is an OSS project and does not contain a dedicated resource on it - Refactored contributors/page.tsx to be a bit more internally consistent with the rest of the application in regards to location - Moved description to config/contributors.ts and will later expand. This is for i18n standardisation later on
- Standardised UI/UX of the Card to the Rest of Our Application & Changed Inconsistent Function Definitions to Functional Components
- Moved contributions to frontend/config & started refactoring code / redesigning schema in preperation to move the types to the backend under contributors.model.ts - Removed unused import
- Created Components / Images for Common Git Operations
- Abstracted out show minimise button into a function in commons to allow usage in EditorBlock & Contributions Pages
- Added Edge Case for RAW Mode to show 1 column instead of two in multi-view modes, due to only one column showing regardless
- Added IsMinimized to Contribution Cards
Owner
|
Had a review & overall LGTM! I will have to do some minor tweaks tomorrow in regards to type safety & moving types to backend interface w/ Zod & regenerate frontend types but the UI/UX looked very stable. I've just done some minor changes to the CSS classes to be a bit more consistent with other pages so the movement is a bit more seamless (this is also a WIP and requires a tiny bit more rework till it's good) |
- Generated Frontend Types for Contributor Updated Frontend types again
Contributor
Author
|
i feel bad the amount of code you have to refactor 😭 so much to learn |
Owner
|
We do a little bit of a refactor 😆 Most of it is good, I'm just OCD with styling & mainly interfaces so I split them up and fixed the typing. Not a scalable solution long term and honestly my codes a bit ugly but it's good enough for now. I'll scope moving this from frontend to backend as a future ticket... if it becomes unscalable |
ShaanCoding
added a commit
that referenced
this pull request
May 15, 2024
…115) * [aminbeigi] Replace FS with MongoDB (#106) * read from DB instead of FS to get Template * add MacroModel * Minor Fixes to MongoDB PR - Uncommented Exception as MongoDB URI is setup on production - Refactored readNjkFiles to instead readFS as this doesn't get the correct key macros causing issues on frontend - Removed console.log on sidebars - Added a TODO comment for future work --------- Co-authored-by: Shaan <22236218+ShaanCoding@users.noreply.github.com> * Updated Environment Variables (#110) - Updated Environment Variables to hit PRIVATE_URL (VPC) to prevent unauthorised access to DB * [Shaan] Generator Page Too Cramped (#108) * Add Category on Click - Added the ability for categories to be added to the sidebar, filtering options on click - Added tooltip indicating that it's clickable - Removed tooltip / logic on non-sidebar applicable cards i.e. TopThreeCards * Removed TabContents - Select Template Page grabs data based on API call, no point containing a TabsContent label that isn't used * Created Raw Text Component - To style later, right now using it as a placeholder component * POC: MainContent Multiple Views - Really poor performance, unloads the blocks and is clunky but shows proof * Refactored Tab Logic - Decoupled Tab Logic to seperate components and isolated areas of concerns - Added Helper Functions to assist with state value mutations * UI Enhancements - Updated Lucide React Library & Added Column Icons - Added Consistent Animations for Changing Tabs * Removed Border on Single Grid View * Added Full View * Updated Generator Buttons - Updated Generator Buttons for consistency * [Bobrandy13] Created Contributions Page (#83) * Added a new contributions page at the end of the website * reverted the mess i made Should hopefully be a working contributions page * Added a new contributions page at the end of the website * Removed old contributions page * Small Refactor - Moved from team to contributors as the URL - Added the route to header & footer, instead of only footer and updated the name from "Team" to "Contributors" as this is an OSS project and does not contain a dedicated resource on it - Refactored contributors/page.tsx to be a bit more internally consistent with the rest of the application in regards to location - Moved description to config/contributors.ts and will later expand. This is for i18n standardisation later on * Formatted Card - Standardised UI/UX of the Card to the Rest of Our Application & Changed Inconsistent Function Definitions to Functional Components * Moved Contributions.ts to frontend/config - Moved contributions to frontend/config & started refactoring code / redesigning schema in preperation to move the types to the backend under contributors.model.ts - Removed unused import * Created Git Icon States w/ Colors - Created Components / Images for Common Git Operations * Moved ShowMinimize Button Into Function - Abstracted out show minimise button into a function in commons to allow usage in EditorBlock & Contributions Pages * Bug Fix: generateNumberOfViews utils - Added Edge Case for RAW Mode to show 1 column instead of two in multi-view modes, due to only one column showing regardless * Removed Logger * Added Is Minimized Button - Added IsMinimized to Contribution Cards * Generated New Frontend Types - Generated Frontend Types for Contributor Updated Frontend types again * Moved contributions to contributor.ts config file * Created Github ContributionLinks Factory * Fixed Contribution Card & Subproperties * Added Contribution Data * Refactored Page / Component Names * Fixed Build Issues --------- Co-authored-by: Shaan <22236218+ShaanCoding@users.noreply.github.com> * [Shaan] Environment Variables + MongoDB (#113) * Added Config For Multi Environment APIs - Added .env.example - Refactored API calls * Updated MongoDB Configuration - Updated MongoDB Configuration to create db called makereadme instead of test default * [Shaan] Optimised Frontend (#114) * Cleaned up environment variables and fixed FS issue * Added Docker File * Created Docker File & Cleanup - Fixed error with FS not being imported - Created Docker file speeding up frontend deployments from 10 minutes to 2 minutes - Cleaned up build process for deployment saving remaining - Cleaned up .env examples * [Shaan] Docker Env Patch (#116) * Added Build Argument * Patched no body logic, as we want to return [] * Added Drop Logic per Deployment / Restart To Prevent Issues - Note: Horizontal scaling issues will be present --------- Co-authored-by: Amin Beigi <me@aminbeigi.com> Co-authored-by: Kevin Huang <91509842+bobrandy13@users.noreply.github.com>
ShaanCoding
added a commit
that referenced
this pull request
May 15, 2024
* [aminbeigi] Replace FS with MongoDB (#106) * read from DB instead of FS to get Template * add MacroModel * Minor Fixes to MongoDB PR - Uncommented Exception as MongoDB URI is setup on production - Refactored readNjkFiles to instead readFS as this doesn't get the correct key macros causing issues on frontend - Removed console.log on sidebars - Added a TODO comment for future work --------- Co-authored-by: Shaan <22236218+ShaanCoding@users.noreply.github.com> * Updated Environment Variables (#110) - Updated Environment Variables to hit PRIVATE_URL (VPC) to prevent unauthorised access to DB * [Shaan] Generator Page Too Cramped (#108) * Add Category on Click - Added the ability for categories to be added to the sidebar, filtering options on click - Added tooltip indicating that it's clickable - Removed tooltip / logic on non-sidebar applicable cards i.e. TopThreeCards * Removed TabContents - Select Template Page grabs data based on API call, no point containing a TabsContent label that isn't used * Created Raw Text Component - To style later, right now using it as a placeholder component * POC: MainContent Multiple Views - Really poor performance, unloads the blocks and is clunky but shows proof * Refactored Tab Logic - Decoupled Tab Logic to seperate components and isolated areas of concerns - Added Helper Functions to assist with state value mutations * UI Enhancements - Updated Lucide React Library & Added Column Icons - Added Consistent Animations for Changing Tabs * Removed Border on Single Grid View * Added Full View * Updated Generator Buttons - Updated Generator Buttons for consistency * [Bobrandy13] Created Contributions Page (#83) * Added a new contributions page at the end of the website * reverted the mess i made Should hopefully be a working contributions page * Added a new contributions page at the end of the website * Removed old contributions page * Small Refactor - Moved from team to contributors as the URL - Added the route to header & footer, instead of only footer and updated the name from "Team" to "Contributors" as this is an OSS project and does not contain a dedicated resource on it - Refactored contributors/page.tsx to be a bit more internally consistent with the rest of the application in regards to location - Moved description to config/contributors.ts and will later expand. This is for i18n standardisation later on * Formatted Card - Standardised UI/UX of the Card to the Rest of Our Application & Changed Inconsistent Function Definitions to Functional Components * Moved Contributions.ts to frontend/config - Moved contributions to frontend/config & started refactoring code / redesigning schema in preperation to move the types to the backend under contributors.model.ts - Removed unused import * Created Git Icon States w/ Colors - Created Components / Images for Common Git Operations * Moved ShowMinimize Button Into Function - Abstracted out show minimise button into a function in commons to allow usage in EditorBlock & Contributions Pages * Bug Fix: generateNumberOfViews utils - Added Edge Case for RAW Mode to show 1 column instead of two in multi-view modes, due to only one column showing regardless * Removed Logger * Added Is Minimized Button - Added IsMinimized to Contribution Cards * Generated New Frontend Types - Generated Frontend Types for Contributor Updated Frontend types again * Moved contributions to contributor.ts config file * Created Github ContributionLinks Factory * Fixed Contribution Card & Subproperties * Added Contribution Data * Refactored Page / Component Names * Fixed Build Issues --------- Co-authored-by: Shaan <22236218+ShaanCoding@users.noreply.github.com> * [Shaan] Environment Variables + MongoDB (#113) * Added Config For Multi Environment APIs - Added .env.example - Refactored API calls * Updated MongoDB Configuration - Updated MongoDB Configuration to create db called makereadme instead of test default * [Shaan] Optimised Frontend (#114) * Cleaned up environment variables and fixed FS issue * Added Docker File * Created Docker File & Cleanup - Fixed error with FS not being imported - Created Docker file speeding up frontend deployments from 10 minutes to 2 minutes - Cleaned up build process for deployment saving remaining - Cleaned up .env examples * [Shaan] Docker Env Patch (#116) * Added Build Argument * Patched no body logic, as we want to return [] * Added Drop Logic per Deployment / Restart To Prevent Issues - Note: Horizontal scaling issues will be present --------- Co-authored-by: Amin Beigi <me@aminbeigi.com> Co-authored-by: Kevin Huang <91509842+bobrandy13@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello,
I made the contributions page.
Please let me know what to change and I am happy to change it. Will maybe begin working on the dynamic data fetching?
Thanks