Code Monkey home page Code Monkey logo

website's Introduction

KUOSC Website

URL: https://kuosc.org.np This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Contributing

You can contribute in this repository by forking it, creating a separate branch to do the task, making some changes, and creating pull request in this repository.

Warning: DONOT use npm or pnpm to install dependencies. Rather, just use yarn. Github actions will fail if you use anything other than yarn.

website's People

Contributors

aadarshadhakalg avatar abhiyandhakal avatar dipenkhatri7 avatar erwinschrodinger1 avatar kuoscofficial avatar notsugat avatar razzat008 avatar s-sigdel avatar sabinonweb avatar sanjibdahal avatar shri-acha avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

website's Issues

Enhancement: Populate About and Setup/Guide Sections in Project Pages

The Project section of the Kathmandu University Open Source Community website currently lists projects, but lacks essential information in the About and Setup/Guide sections. This makes it challenging for users to understand the projects and how to contribute effectively.

Expected

About Section: Provide a brief overview of each project, including its purpose, goals, and
Setup/Guide Section: Offer clear instructions on how to set up the project environment and contribute to the project.

Steps to Reproduce

  • Visit the Projects section of the website
  • Click on any project listed.
  • Observe the lack of information in the About and Setup/Guide sections.

Additional Information

Including detailed information in the About and Setup/Guide sections will improve user engagement and facilitate contributions from the community.

This enhancement aligns with the community's goals of promoting open-source collaboration and providing resources for project contributors.

Priority

This enhancement is of high priority as it directly impacts the usability and effectiveness of the website.

Create Readme File for KUOSC Website Repository

Issue Description:

The KUOSC website repository currently lacks a README file, which is a fundamental component of any open-source project. A well-crafted README file serves as the introduction and first impression of the project for potential contributors, users, and other interested parties. It provides essential information about the project's purpose, features, installation instructions, and usage guidelines.

By addressing this issue and creating a comprehensive README file, the KUOSC community can effectively communicate the project's goals, usage instructions, and contribution guidelines. This will make it easier for newcomers to understand and engage with the project, ultimately fostering collaboration and growth.

Reference Links:

https://github.com/kuosc2005/merchandise-design

Fix spacing on KUCC shoutout section

Issue Description:

Uneven spacing can be seen in the current version of the website. The KUCC shoutout section is not expanded to its full container width. Also, adding a about KUOSC section above the KUCC section would look good. And the whole thing can be moved below hero section and above what we do section. And finally, about KUCC heading text can be removed and both About KUOSC and About KUCC comes under About heading.

image

Missing Contributing Guidelines, Code Contributions, Documentation Contributions, and Management Contributions Pages

Issue Description:

The KUOSC website repository is currently lacking essential documentation for various contributions and management aspects. This documentation is crucial for maintaining a transparent and efficient workflow within the community.

The following pages are missing documentation:

  • Contributing Guidelines Page: This page should provide clear instructions on how individuals can contribute to the KUOSC project, including the codebase, documentation, and other aspects of the project.
  • Code Contributions Page: Detailed instructions on how to contribute code to the KUOSC project are missing. This includes steps for setting up the development environment, coding standards, submitting pull requests, and reviewing code.
  • Documentation Contributions Page: The absence of documentation on how to contribute to the project's documentation hinders the growth of the project. This page should guide contributors on how to improve and expand the project's documentation resources.
  • Management Contributions Page: A well-defined guide for individuals who want to contribute to the management and organization of the KUOSC project is lacking. This page should outline roles, responsibilities, decision-making processes, and how to get involved in non-technical aspects of the project.

Reference Links:

https://community.moja.global/community/code-contribution
https://community.moja.global/community/docs-contribution
https://community.moja.global/community/management-contribution
https://community.moja.global/community/contributing

Adding Documentation

If you want to help resolve this issue, you have to perform following steps.

  1. Create fork of this repository
  2. Clone the forked repository and create markdown files inside, knowledgebase folder. Each markdown file will be rendered as a page in the website. Example: https://github.com/kuosc2005/website/blob/main/knowledgebase/intro.md
  3. Commit changes and create a PR referencing this issue.

Thanks.

Improvement of color palette

Dark color palette looks a bit bland.
image
Instead of available color, we can use something different... like #228522. It looks like this after the update:
image

Add CI/CD pipeline

this website is switching to VPS hosting form vercel. Add ci/cd pipeline for automatic deployment in vps

Footer links not functioning properly

The footer links for "Open School," "Linux Talk," and "Localization" are not functioning as expected. Users are unable to navigate to the respective pages when clicking on these links.

Steps to reproduce:

  1. Go to the bottom of the website
  2. Attempt to click on the Open School
  3. Attempt to click on the Linux Talk
  4. Attempt to click on the Localization

Expected behavior:
Upon clicking the above links users should be directed to the respective pages related to "Open School," "Linux Talk," and "Localization."

Actual behavior:
Users are unable to access the content related to "Open School," "Linux Talk," and "Localization" due to the broken links.
image

Enhancement of UI/UX of contribution leaderboard section

The leaderboard section on our website lacks visual appeal and fails to engage users effectively. We need to revamp its design to make it more attractive and interactive.

Proposed Changes:

  1. Visual Refresh: Update the design to make it more visually appealing and in line with our website's theme.

  2. Interactive Elements: Add animations, hover effects, or transitions to make the leaderboard more engaging.

  3. Clear Information Hierarchy: Organize the information in a clear and easy-to-understand manner. Use colors and icons to differentiate between different elements.

  4. GitHub Contributions Display: Integrate GitHub contributions data directly into the leaderboard, showcasing the number of contributions and lines of code changed by each user ( backend first ).

  5. Responsive Design: Ensure that the leaderboard looks good and functions well on all devices.

  6. Performance Optimization: Improve the loading speed and overall performance of the leaderboard section.

Reference Design:
Take inspiration from the leaderboard section on Code Racer. Note the vibrant colors, clear typography, and interactive elements used to create an engaging experience and hover to show latest commits.

Additional Information:
Your feedback and ideas for improving the leaderboard section are welcome. Let's work together to create a leaderboard that motivates users to engage with our platform.

Acceptance Criteria:

  • The redesigned leaderboard section should be visually appealing and easy to use.
  • Top contributors and their achievements should be highlighted effectively, including GitHub contributions data.
  • The leaderboard should work well on different devices and browsers.
  • Performance optimizations should be implemented to ensure fast loading times.
  • The final design should match our website's theme and brand identity.

Let's collaborate to improve the leaderboard section and create a better user experience for our website visitors.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.