Pankod

Pankod

  • Docs
  • Github

›Project CLI

Introduction

  • Getting Started
  • What's included?
  • Setup
  • Structure
  • Deployment

Features

  • Styling
  • Routing
  • Unit Testing
  • Reverse Proxy
  • Environment Variables
  • Internationalization Framework
  • Storybook

Project CLI

  • Overview
  • Usage
  • Migration Guide

Usage

After starting, an interactive menu will let you configure the component to be created. Firstly, you'll be asked for the type of the component whether it's a page or a functional component. Then you'll be prompted with the other options relevant to your selection.

For example, let's go through the steps of the creation of a new page component.

Enter page name

  • Enter the desired filename for the page. Spaces are not allowed!
  • The tool will check for the existing filenames in the project and reject if finds any.
  • The interface files are going to be created under Interfaces/Pages directory.

Do you want to add custom route or use default route name?,

  • You can define custom route for page which is specified in server/routes.ts
  • It will set filename as a route if you don't want to add custom route.

Do you want to have a connection to store?

If you choose yes, the following store connection methods and imports will be generated:

  • Implement getInitialProps and appropriate imports in page component file,
  • An action file in the Actions/{YourAwesomePage} folder,
  • Prepend export line into Actions/index.ts,
  • An action constants object in Definitions/ActionConsts/ActionConsts.ts,
  • Append component interface in IStore interface file.

Do you want to create a new reducer or use your own?

  • If you choose yes, a new reducer file for page will be created in src/Redux/Reducers/{yourAwesomePage} directory and reducer will be appended in combineReducers.

What kind of css do you want to implement?

  • If you choose scss/sass, a style.scss file will be created right next to page file.
  • Otherwise a styled container element will be created with default styles.

Eventually, you'll end up with a page or component with style and test files in no time.

← OverviewMigration Guide →
Pankod
Docs
Getting StartedProject-CLIUnit Testing
Community
Twitter
More
GitHubStar
Pankod Open Source
Copyright © 2020 pankod