Giter Club home page Giter Club logo

c2siorg / webiu Goto Github PK

View Code? Open in Web Editor NEW
7.0 3.0 15.0 8.11 MB

Building and maintaining a website is an essential task for any business or organization. This project aims to ease the workflow of getting a website up and running by developing a “generalized website builder”, with the help of the Gatsby Js Framework. The individuals would be able to utilize this generalized platform to plug-in required module…

License: MIT License

JavaScript 85.81% Sass 13.47% HTML 0.72%

webiu's Introduction

WebiU

Building and maintaining a website is an essential task for any business or organization. This project aims to ease the workflow of getting a website up and running by developing reusable Gatsby Components which are easily plugable to create Gatsby websites with ease.

Website built with Webiu: https://www.scorelab.org/

Installation

The project is based on ReactJs, JavaScript and GatsbyJs. You need to make sure that you have compatible versions of node/yarn, npm installed. SASS as the stylesheet is used in this project.

Initial Setup

Fork the repository as your own copy https://github.com/ <Your Username> /Webiu.git

Clone the repository in your local system git clone https://github.com/ <Your Username> /Webiu.git

Local Development Setup

You will need to have Gatsby CLI installed into your system Go to the offical Gatsby documentation and proceed further to set up the Gatsby CLI https://www.gatsbyjs.com/docs/tutorial/

Cd into the project

cd Webiu

Install All Dependencies

npm install

Errors if any?

Got Stuck? Don't forget to give a look to the troubleshooting guides https://www.gatsbyjs.com/docs/how-to/local-development/troubleshooting-common-errors/

If everythings seems normal, you are good to go :)

Develop the project

run npm develop or gatsby develop

Your site must be visible at http://localhost:8000

About The NPM Package

The webiu components now have a seperate dedicated npm-package which increases its reach to the developers. It has all the components exported and can be easily plugged into your next project. It is highly recommended to install and use the package:

https://www.npmjs.com/package/webiu-npm

Usage of the NPM package

The npm package of webiu can be used in your next proejct. A sample project demonstrating he use-cases of the package is developed and is visible at:

https://grumpyyash.github.io/webiu-npm-test/

StoryBook Visualization of the Components

All the webiu components are well-documented using StoryBook, a powerful visualization tool for reviewing UI. The storybook for webiu is deployed live on:

https://grumpyyash.github.io/Webiu

And, it is also deployed on chromatic - https://610d0e8b03a01e003b2f5070-rllntdhgdq.chromatic.com/

Contributing to the Project

We value our contributers a lot and would appreciate contributions to our project. Please make sure to follow our contributing guidelines. Please clearly explain any bugs, issues or feature requests (use screenshots wherever applicable) before opening any issue or pull request.

May the source be with you!

webiu's People

Contributors

abhijay007 avatar aditya-mitra avatar charithccmc avatar dinithminura avatar gdsghost avatar gillaarun avatar grumpyyash avatar maahi10001 avatar ravindu-hirimuthugoda avatar saurabhsonde avatar wdevon99 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

webiu's Issues

Inquiry Regarding Contribution to WebiU 2.0 Project

Hey there,

I hope this message finds you well. Firstly, I'd like to extend my apologies for raising an issue here; I understand this might not be the typical channel for such inquiries.

I am Uday, a computer science undergraduate with a passion for full-stack development, including expertise in Next.js, React, TypeScript, JavaScript, Node.js, Tailwind CSS, Electron, Docker, CI/CD, Java, Python, C++, and Angular. I recently came across the WebiU 2.0 project in your organization, particularly interested in its dynamic organization website initiative.

After visiting the GitHub repository , I couldn't find a clear path to the Slack channel mentioned in the project documentation. I attempted to join c2si.slack.com, but unfortunately, it's not accepting email signups.

I'm very much interested in contributing to the WebiU 2.0 project and would appreciate your guidance on the next steps. Could you confirm if this is the correct repository to contribute to? If so, what specific tasks or issues should I focus on first? Additionally, any information on alternative communication channels for the project would be immensely helpful.

About me: I bring a diverse tech stack and a keen interest in contributing meaningfully to open source projects. I am excited about the prospect of working on the dynamic organization website, and I'm committed to making a positive impact on the project.

Thank you for your understanding, and I look forward to your guidance.

Best regards,

Uday

@Maahi10001

WebiU 2.0 Pre-GSoC Task Channel link :- https://c2si-org.slack.com/archives/C06E698JDNY

Workflow Design:

  • Define a data flow process to fetch project information from GitHub repositories and integrate it into the organization's website, ensuring real-time updates.

  • Establish mechanisms for automatic website updates triggered by changes in GitHub repositories, utilizing webhooks or periodic checks.

  • Implement error handling protocols to manage exceptions during data retrieval or integration, including logging errors and implementing fallback mechanisms.

Figma Design for UI:

  • Create wireframes and UI designs for the organization's website interface, focusing on project display sections, admin control panels, and configuration settings.

  • Develop UI components such as project cards and navigation menus, ensuring a cohesive and user-friendly interface with attention to visual hierarchy and typography.

  • Prototype interactions within the interface using Figma, simulating user actions like toggling project visibility or updating project details.

Backend Design:

  • Select a suitable backend technology based on scalability, performance, and integration capabilities with GitHub APIs and also why you are selecting it and some Ideas on Implement RESTful API endpoints for communication between the frontend and backend, enabling actions such as retrieving project information, managing configurations, and updating settings while ensuring security through authentication and authorization mechanisms.

Note: All These should follow project description and requirements only

please keep task result with URL accessible and secure, can mail them to [email protected] for any queries or suggestions, Reach out to slack channel or write to [email protected] All the best and keep coding ;)

Make navigation bar responsive

Is your feature request related to a problem? Please describe.
Currently the Navigation bar is not responsive so make it responsive for all the devices

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Make Publications page responsive

Describe the Issue
Make the publications page responsive for all devices

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A detailed description of the expected behaviour

Screenshots
If possible, please use screenshots

Desktop (please complete the following information):

  • OS: [e.g. iOS/Windows]
  • Browser [e.g. chrome]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. mozilla, safari]
  • Version [e.g. 22]

Having trouble setting up the project locally.

Describe the bug
Upon running npm install initially, I encountered an error related to conflicting dependencies. I attempted to resolve it by using npm i --legacy-peer-deps. However, I encountered the following error afterward:

stack     import sys; print "%s.%s.%s" % sys.version_info[:3];
npm ERR! gyp ERR! stack                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
npm ERR! gyp ERR! stack SyntaxError: Missing parentheses in call to 'print'. Did you mean print(...)?
npm ERR! gyp ERR! stack
npm ERR! gyp ERR! stack     at ChildProcess.exithandler (node:child_process:419:12)
npm ERR! gyp ERR! stack     at ChildProcess.emit (node:events:511:28)
npm ERR! gyp ERR! stack     at maybeClose (node:internal/child_process:1098:16)
npm ERR! gyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:304:5)
npm ERR! gyp ERR! System Windows_NT 10.0.22631
npm ERR! gyp ERR! command "C:\\Program Files\\nodejs\\node.exe" "C:\\Users\\shash\\Desktop\\Webiu\\node_modules\\node-gyp\\bin\\node-gyp.js" "rebuild"
npm ERR! gyp ERR! cwd C:\Users\shash\Desktop\Webiu\node_modules\sharp
npm ERR! gyp ERR! node -v v20.3.1
npm ERR! gyp ERR! node-gyp -v v3.8.0

To Reproduce
Steps to reproduce the behavior:

  1. Navigate to the main directory of Webiu using cd webiu.
  2. Execute npm install --legacy-peer-deps.
  3. Observe the error message in the terminal.

Expected behavior
After running npm install, the application should function correctly when executing npm develop or gatsby develop.

Screenshots
Legacy Peers
npm install

Desktop Configurations

  • OS: Windows 11
  • IDE: WebStorm
  • Node Version: 20.3.1

Refactoring the styles to make page responsive

Describe the bug
Change the px to rem

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A detailed description of the expected behaviour

Screenshots
If possible, please use screenshots

Desktop (please complete the following information):

  • OS: [e.g. iOS/Windows]
  • Browser [e.g. chrome]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. mozilla, safari]
  • Version [e.g. 22]

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.