Skip to content

Instantly share code, notes, and snippets.

@utkar-sh-ukla
Last active March 10, 2023 20:02
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save utkar-sh-ukla/20b6304471956d6ea11ec9ad7de6d7e3 to your computer and use it in GitHub Desktop.
Save utkar-sh-ukla/20b6304471956d6ea11ec9ad7de6d7e3 to your computer and use it in GitHub Desktop.
GSOC'22 Work-Product

google summer of code logo

Google Summer of Code 2022: Work Product Submission

Utkarsh Shukla (@μtkarsh)

Project Abstract

This project aims to update the website for the PostgreSQL JDBC Driver, a Java-based driver that enables Java applications to connect to PostgreSQL databases using standard Java code. The current website is based on an outdated PostgreSQL template and is built using Jekyll. The objective is to create a more modern website that can be easily built from GitHub actions, allowing for automated updates.

Mentors: Dave Cramer (@davecramer), Andreas 'ads' Scherbaum (@andreasscherbaum)

Updated - https://jdbc.postgresql.org/
Before my redesign - https://web.archive.org/web/20220803122754/https://jdbc.postgresql.org/

Work Details

In creating a new website, I followed a series of steps to ensure that the website would be visually appealing, user-friendly, and meet the users' requirements. These steps included:

  1. Gathering requirements : The first step was to understand the requirements from mentors and the community. This involved identifying the specific features that needed to be included and the addition of new content.

  2. Planning and research : Once the requirements were gathered, I started planning the website structure and conducted research to gather ideas on new design trends.

  3. Developing a wireframe : The next step was to create a wireframe that would serve as a basic visual guide representing the website's layout and content. This helped identify the website's essential components, such as the header, footer, and navigation bar.

  4. Creating a design concept : With the wireframe complete, I began creating the design concept. This involved selecting a color scheme, choosing fonts, and creating a layout that was visually appealing and user-friendly.

  5. Developing the website : After the design concept was approved by the mentors and the community, the coding work began. This included selecting the tech stack, coding the website, adding content, and ensuring that it was mobile responsive. The tech stack used included Hugo, HTML, SASS(SCSS), Javascript.

  6. Testing and refining : Once the website was complete, it was tested to ensure that it was fully functional and met all user requirements. Any necessary refinements were made based on feedback from the mentors and community.

  7. Launching the website : After testing and refinement, the website was launched. This involved making it live and optimizing it for search engines.

By following these design work details, I created a new website for pgJDBC that met the user requirements and provided a positive user experience.

Challenges and learning

While working on the redesign of the pgjdbc website, I faced a significant challenge in the form of the previous website's lack of a proper homepage. The website only displayed changelogs, which made it challenging for me to decide on the design, content, and placement of elements on the homepage.

To overcome this challenge, I took inspiration from the postgres website and other postgres sub-projects to gather ideas and content for creating a wireframe of the homepage. After creating the wireframe, I shared it with the community and solicited feedback and suggestions on the design.

By taking suggestions from the community, I was able to finalize the design of the homepage.

Future Goals

Here are some of the future goals:

  1. Dark theme : This feature will improve the website's aesthetics and provide a better user experience. This feature will be particularly useful for users who prefer a darker color scheme, are working in low-light environments, or have sensitivity to bright light.

  2. Code snippets copy feature : With this feature, users can quickly and easily copy code snippets and paste them into their projects without having to manually type out the code. This saves users a significant amount of time and effort, especially for larger code snippets.

  3. Version Selector : This feature will allow users to select the version of the documentation they want to view from a drop-down menu. When the user selects a specific version, the website will display the relevant documentation for that version. This feature will simplify the process of accessing the desired information without the need to search or navigate through multiple pages.

Acknowledgements

I would like to express my sincere appreciation to Google for granting me the opportunity to participate in the Google Summer of Code (GSoC) program. This program has been an invaluable experience for me, enabling me to improve my software development skills and gain hands-on experience working on open-source projects.

I am extremely grateful to my mentors, Dave Cramer and Andreas Scherbaum, for offering me the chance to work on this outstanding project. I am truly thankful for their constant support, timely and thorough code reviews, and willingness to engage in regular discussions to help me resolve any queries I had.

Furthermore, I would like to thank Vladimir Sitnikov, Susan, Jorge Solórzano, Sehrope Sarkuni and the entire pgjdbc community for their assistance in completing this project. They provided me with valuable feedback, creative ideas, and helpful suggestions, which contributed to the successful completion of this project. I am grateful for their contributions and am delighted to have been a part of this supportive and collaborative community.

Post GSoC

After the completion of my Google Summer of Code (GSoC) project, I have found contributing to pgjdbc to be a fulfilling experience, and I am determined to continue my involvement in the project. In addition to contributing code, I plan to review other contributors' work to ensure the highest quality standards and offer assistance in maintaining the project's stability and progress. I believe that this will not only help me enhance my skills as a developer but also contribute to the success of an important open-source project.

References

@warisamir
Copy link

wow nice ui bro

@utkar-sh-ukla
Copy link
Author

Thanks @warisamir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment