Skip to content

ArafatAbdussalam/geek-devs-frontend

 
 

Repository files navigation

geek-devs-frontend

Repository for Geek Devs frontend code

Project Structure

This describes how the folder structure for how we are organizing our project

├───assets
├───components
│   └───Component
|			└───__tests__
|						└───Component.test.jsx
|			└───Component.jsx
|			└───Component.stories.js
|			└───styles.css
|			└───index.js
├───pages
│   └───Page
|			└───__tests__
|						└───Page.test.jsx
|			└───Page.jsx
|			└───Page.stories.js
|			└───styles.css
|			└───index.js

STORYBOOK SETUP

DESCRIPTION

  • To setup a component library(storybook) for our project
  • This project involves installing and running storybook locally

HOW TO GAIN ACCESS TO THE STORYBOOK-SETUP REMOTE BRANCH

Clone the root repository

  • git clone https://github.com/growwithuduak/geek-devs-frontend.git

Note: Ensure you are on the main branch and that you have made commits to your previous projects before checking out to a new branch.

Fetch all the remote branches from the repository

  • git fetch origin

Check the list of available branches

  • git branch -a

Create a copy of the remote branch to your local repository

  • git checkout -b name/storybook-setup origin/feature/storybook-setup

For example, my copy of the remote branch is named Arafat/storybook-setup

Open the files in terminal using:

  • code .

Push to the upstream branch (upstream branch is the remote branch which is being tracked by your local branch), using:

  • git push origin HEAD:feature/storybook-setup

Note: It is important to follow the push instructions given above. This will ensure that your contribution is reflected in the feature/storybook-setup branch which is our remote branch for the project

Pull changes made to the remote branch using:

  • git pull

This will update your local directory so it can be in sync with the one on the remote repository before you start working on your task.

HOW INSTALL THE PROJECT

Install all the package dependencies

  • npm install

HOW RUN IT LOCALLY

Run the project on your local machine:

  • npm run start-storybook

About

Respository for Geek Devs frontend code

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 59.8%
  • CSS 35.0%
  • HTML 5.2%