Landing Page JS Libray

Table of contents

• Directory Layout
• Installation
• Start Dev Server
• Build Prod Version
• Adding New JS
• Versioning
• Release Steps
• Features
• Documentation

Directory Layout

.
├── dist                    # Compiled files
│   ├── app.js  # Minified JS file
│   └── ......              # Individual JS scripts    
├── src                     # Source files
│   ├── js-landing-page.js  # Main JS file
│   └── scripts             # Individual JS scripts     
├── webpack
├── package.json
├── babel.config.js
├── .eslintrc
└── README.md

Installation

npm install

Start Dev Server

npm start

Build Prod Version

npm run build

Adding New JS

In order to add new JS we need to follow these steps:

• Create the new file under /src/scripts
• Add the new entry point in /webpack/webpack.config.common.js, remember to always add the new entry point on top
• Add the new export in /src/js-landing-page.js

Versioning

We follow the Semantic Versioning guidelines.

Release Steps

In order to release a new package version we need to apply the following steps:

• Update the package version in the package.json file.
• Run npm publish.
• Done! The new package version can be checked here
• After releasing the new version, create a new tag with the release notes, remember to follow the convention shown in the main README

Features:

• ES6 Support via babel (v7)
• Linting via eslint-loader

Documentation

• Custom Forms
• Common Form Validations
• Group Enrollment Modal
• Sticky Nav
• Native Form