Poltergeist Boilerplate Framework

This is the in-house Poltergeist Boilerplate project creation framework currently supporting a handful of frontend project setup. This contains a setup with Webpack configured legacy frontend application and a scalable React application setup and a scalable React application setup built on Next JS.

Installation

1. Generate an SSH key and add the PUBLIC KEY to your GitHub account. Make sure that your account has access to the in-house repository of polt-create

2. In your local machine, open up a terminal with superuser or administrator rights. We need to install the package globally. So run the command npm install -g git@github.com:pingPoltergeist/polt-create.git

3. You would normally be prompted to log in to your GitHub account multiple times during installation. After that the package would be installed successfully and will be ready to use.

Usage

1. One-page App: To create a one-page application, navigate to the project directory (ideally empty) and run the command in a shell polt-create onePager. File structure would be generated and dependencies would be installed. Then the application would automatically open up in a browser window.

2. React App: To create a React application, navigate to the project directory (ideally empty) and run the command in a shell polt-create reactApp. File structure would be generated and dependencies would be installed. Then the application would automatically open up in a browser window.

3. Next App: To create a Next JS application, navigate to the project directory (ideally empty) and run the command in a shell polt-create nextApp. File structure would be generated and dependencies would be installed. Then the application would automatically open up in a browser window.

Commands at a glance

1. polt-create onePager for one-page app

2. polt-create reactApp for React app

3. polt-create nextApp for Next JS app

Build

1. Clone the repository in an appropriate directory

2. Open up a command line window in that directory with superuser or administrator privileges.

3. Run the command npm link

4. Don't forget to run npm unlink after you are done

Copyright (c) 2021 Poltergeist