-
Clone the application.
# Clone the repo git clone git@github.com:thmsmtylr/easygo.git
-
Install the dependencies.
Navigate into your new siteβs directory and install the necessary dependencies.
# Navigate to the directory cd easygo/ # Install the dependencies yarn
-
Open the source code and start editing!
Open the
easygo
directory in your code editor to view the components! -
Browse your stories!
Run
yarn storybook
to see your component's stories athttp://localhost:6006
-
Deploy to Chromatic
Run
npx chromatic --project-token=CHROMATIC_TOKEN
to deply your components.
A quick look at the top-level files and directories included with this template.
.
βββ .storybook
βββ node_modules
βββ public
βββ scripts
βββ src
βββ .babelrc
βββ .gitignore
βββ yarn.lock
βββ package.json
βββ LICENSE
βββ rollup.config.json
βββ README.md
-
.storybook
: This directory contains Storybook's configuration files. -
node_modules
: This directory contains all of the modules of code that your project depends on (npm packages). -
public
: This directory will contain the development and production build of the site. -
scripts
: This directory will contain all the modules required should you want to setup Typescript in your project. -
src
: This directory will contain all of the code related to what you will see on your application. -
.babelrc
: This file tells babel how to transpile the application's code. -
.gitignore
: This file tells git which files it should not track or maintain during the development process of your project. -
.rollup.config.json
: This is a configuration file for rollup.js. Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as libraries or applications. -
package.json
: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project. -
LICENSE
: The template is licensed under the MIT licence. -
yarn.lock
: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (Do not change it manually). -
README.md
: A text file containing useful reference information about the project.