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!