muflihun-fe

Frontend components for new website

The backend is not available for publish just yet. Muflihun Labs team will decide to

Install

You will need to install all the packages' dependencies. Use following command to get started

yarn ready

Create New Package

Use following script to generate a new component or page

  yarn new

The page should start with pa e.g, pa-homepage will generate a package muflihun-fe-pa-homepage. You will be given open to change the component name. E.g, When you create fe-pa-support-us component name will be SupportUsPage. When you hit enter, you can choose to change it to SupportPage or simply hit enter to use default name which is SupportUsPage

The components should start with co e.g, co-breadcrumbs

Run Demo

After the new package is ready, you can run the demo by going to package directory

cd packages/muflihun-fe-pa-homepage
yarn start

Demo uses fixtures from packages/muflihun-fe-pa-homepage/src/lib/demo/fixtures for pages and packages/muflihun-fe-pa-homepage/src/demo/fixtures for components. Do not change this structure as the server will rely on demo fixtures for the pages to test on server before releasing.

Publish

You must build the package before publishing it. We will later automate this process.

We use lerna for publishing the packages to NPM registry.

yarn build && lerna publish

License

All packages are Apache 2.0 licensed.

Copyright 2018-present Muflihun Labs
Copyright 2018-present @abumusamq

https://muflihun.com/
https://muflihun.github.io/

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.