Code Monkey home page Code Monkey logo

fun-react-lib's Introduction

fun-react-lib

A React Library created for fun and learning

About

The motivation behind this library is to help introduce people to open source with a fun and actually usable project. Contributing to open source can be very daunting, so I wanted to create a repository that can help ease people into the world of open source.

Contributing

If you want to contribute to this project please take a look at the guidelines/how-to

Documentation

https://github.com/NehemiahK/fun-react-lib/tree/master/src/docs

fun-react-lib's People

Contributors

ashispavan avatar ferueda avatar helendrug avatar kaf-lamed-beyt avatar krissh-the-dev avatar madhuni avatar nehemiahk avatar nicxzmiller avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

fun-react-lib's Issues

Live preview

It would be nice to have a live preview of the project. Github pages should do the job.

Modal Component

Hey all, I would like to implement an example modal component. There would be a button that says 'Open Modal' and it would close when either the 'close' button is clicked or the background behind it is clicked.

Documentation for the components using Storybook

While creating a lib, I believe we should keep on documenting our components.

We can use StoryBook for that purpose. It will help everyone to use and share components also for the new contributors to get onboarded.

Add pre-commit and pre-push hooks

We need to add pre-commit and pre-push hooks to our repo. This will make sure, anybody who is going to raise a PR to this repo, all the code is formatted and linting has been done.

Commit or push won't happen if there are linting errors. Later on, we can run tests as a condition to make sure that the code is clean and properly tested before it's up for PR.

Add eslint for the project

We should add the eslint in our project so that the code is clean and properly linted and following the industry standards.

The styling of the components page changed?

The styling of the components page changed a lot.

Any idea when this happened?

I see there is a navigation bar on top that doesn't do anything. And i sort of likes the component list on the left.

Not sure I want to deploy this version.

Squash and merge the pull requests to keep the commit history clean

Hi @NehemiahK, I just want to bring this point, let's try to keep the practice of merging the PRs with Squash and Merge option. This will help us to keep the commit history in master to be clean.

If anyone wants to go back to the commits, they can see that in the PR description.

Example commit history from one of my own project:
image

Add storybook for the project

since many people will contribute and create components, it will be nice to have story book in this project,
as well - might add a storybook file to the script creating a component.
what ya think?

Card

Hi, I'm new to open source, I'd like to start here. I want to implement a card component to the library which consists of a fluid material-ish card component with a heading and a paragraph. Also I'd like to add a image to it as well.

Setup branch policies and CI/CD pipeline for the project

We should integrate the CI/CD pipeline for the project.

CI pipeline will make sure that we are following the best practices before merging anything to master. We can have basic format-check and linting-check as of now and later on increase the scope of the CI pipeline.

CD pipeline is going to help us that gh-pages is up and running with the latest changes once the code is merged to the master branch.

Looking for help running this repo

Hey, I'm so happy this repo has been getting a lot of attention and people are really contributing. I could really use some help though managing the repo especially over the weekends when I'm less available.

I'm primarily looking for people who have a decent amount of experience in open source (bonus points for running your own repo).

If this isn't you, that's also fine. I could use help with people adding more issues. Anything from enhancements to new features.

All the best and happy coding!
Nehemiah

Consistent color systems across the library

Let's define colors for the entire library to maintain same color palatte, otherwise the components will become inconsistent and look very different from each other. We can also move to sass for a hassle free implementation. I request everyone reading this to leave a comment on this..

Contact Form

Hello. I would like to implement a contact form. I would like to do just the front-end part as I am not that experienced with back-end. the form can have the name, email and message inputs and the send button.

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.