Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 4.09 KB

README.md

File metadata and controls

118 lines (84 loc) · 4.09 KB
Raw

Puerto Folio

Running the project

$ npm i
$ npm run dev

Project Layout

Project Structure

This repository contains by the general frontend web file structure conventions we use at DEV. It has react-router, apollo integration, and styled-components. It also has a full developer environment with prettier, eslint, and travis set up. The repository was designed first and foremost to scale to large projects. It should be easy to extend the base file structure and setup here to much larger projects.

project-repo-name
└───.storybook
|
└───node_modules
|
└───public
│
└───src
│   │   App.js
|   |   client.js
│   │   config.js
|   |   index.js
|   |   theme.js
│   │
│   └───assets
│   |
│   └───components
│   |   └───LineInput
|   |   |   └─── index.js
|   |   |   └─── styles.js
|   |   |   └─── graphql.js
|   |   |   └─── story.js
│   |   └───NavBar
│   |   └───PageHeader
│   |   └───SubmitButton
│   |   └───TextArea
│   │
│   └───containers
│       └───About
│       └───ContactUs
│       └───Home
│
|   .eslintrc.json
|   .gitignore
|   package-lock.json
|   package.json
|   README.md

Important Directories and Files

  • .storybook

    • Used to configure storybook for the project. If you ever needed to make something globally accessible to all stories, such as the theme, it would go in here.

  • public

    • Used to store the root html and css files, favicon, etc. Note: You cannot import assets from this directory as it is outside of src

  • src

    • The main directory. Used to store all javascript files

  • App.js

    • The root component. Any resources that need to be accessed by the whole app (like redux, theme provider, apollo provider, etc.) must be stored here. We try to keep this file light, so only put work here if it is absolutely necessry

  • config.js

    • Used to store constants that are important to the functionality of the app (like api urls, api keys, query limits, etc.)

  • theme.js

    • Used to store constants that are important to style (like colors, fonts, widths, heights, etc.). This is also where we load our fonts.

  • containers

    • Used to store the different "Pages" of the app. Note: Pages are determined by url. If you can reach a component by going to a specific url and that component is the root of that url, then it should go into containers.

  • components

    • The top level components folder is used to store components that will be used throughout the app. If a component is used in more than one container, then it should be in this folder.

Storybook

Storybook is a tool that allows you to work on and view individual components without having to build an entire page to do so. This becomes very useful as the project grows larger and you are required to navigate 2 or 3 levels deep to even get to the page your component is on (especially when you're restyling minute details like font-size or widths).

Running Storybook

In order to use Storybook you can simply run the following command

$ npm run storybook

This will launch a storybook window in your default browser on localhost:9009. If you would like to view storybook in a different browser, you can simply open that browser and go to localhost:9009.

Creating Stories

In order to create stories, create a new file in your component's directory called story.js (on the same level as index.js). Your file will look something like this:

import React from 'react'
import { storiesOf } from '@storybook/react'
import MyComponent from '../components/MyComponent'

storiesOf('MyScreen', module).add('MyComponent', () => <MyComponent />)

This file tells storybook what to display and how to organize the stories. For the storiesOf parameter, always put the name of the screen it will go on and in the .add parameter, always put the name of component (and maybe some extra info if neccessary about the specific use case of the component).