Starter Kit

Overview:

The Unicorn Standard Starter Kit is a development tool that provides users with pre-configured code and conventions to quickly build a React/Redux based app. This starter kit aims to streamline the development process by setting up the directory structure, configuring ES6 compilation and automatic-reloading development server, and including pre-built views, layouts, and reducers for a simple document editor. The kit also incorporates features like simple uniloc-based routing, Pacomo CSS conventions, and the actors pattern for easy data modeling and state management.

Features:

• Directory Structure: The kit sets up the directory structure as soon as you clone the repository, ensuring a sorted organization for your project.
• ES6 Compilation and Automatic Reloading: The kit includes webpack and Babel configuration for ES6 compilation and automatic reloading during development.
• Redux: Redux is integrated into the starter kit, providing a simple way of modeling data with great community support.
• React: The starter kit uses React, a JavaScript library maintained by Facebook, which simplifies the process of rendering views.
• Simple Uniloc-based Routing: The kit includes a simple routing system that is easy to understand and customize.
• Pacomo CSS Conventions: The use of Pacomo CSS conventions minimizes bugs caused by conflicting styles.
• Actors Pattern: The actors pattern allows for easily reacting to changes in the store without forcing a re-render.
• Preconfigured Redux Store: The starter kit comes with a preconfigured Redux store for navigation, data, and view models.
• Views, Layouts, and Reducers for Simple Document Editor: The kit includes prebuilt views, layouts, and reducers for a simple document editor, making it easier to get started.

Installation:

To get started with the Unicorn Standard Starter Kit, follow these steps:

1. Make sure you have node.js and git installed on your system.
2. Clone the Unicorn Standard Starter Kit repository.
3. Update the name, description, and author in the package.json file.
4. Update the app title in the src/index.html file.
5. Restart the development server after any changes to src/index.html.
6. Set up ES6 syntax highlighting for .js and .jsx files in your editor (e.g., using babel-sublime).
7. Start building your app by adding routes, navigation menu items, components, reducers, actions, and data models as required.
8. Configure your routes in the src/Application.jsx file.
9. Once you’ve made changes, don’t forget to commit them and push to your preferred version control system (e.g., Bitbucket or GitHub).
10. To showcase your app, use the command “gulp dist” to output a web-ready build of your application to the dist folder.

Summary:

The Unicorn Standard Starter Kit is a comprehensive development tool that provides developers with a preconfigured codebase and conventions to quickly build React/Redux based applications. With features like prebuilt directory structure, ES6 compilation, automatic reloading, and preconfigured Redux store, developers can focus on building their app without worrying about setting up the basics. The kit also includes useful features like simple routing, Pacomo CSS conventions, and the actors pattern for state management. By following the installation guide, developers can easily start building their applications using this starter kit.