/opacity-project-front-end

A front-end to Opacity-Project

Primary LanguageJavaScriptMIT LicenseMIT

Opacity-Project Front-end

Storybook code style: prettier JavaScript Style Guide License: MIT

An internal front-end project for Opacity-Project by Akatsuki JS

For members learn a few about:

  • best practices
  • atomic design
  • react
  • css in js
  • build UI components in isolation

See the API and the detailed information about Opacity-Project here

The site is live in opacity-project

🏷️ STATUS: poor first release

It used:

  • Flavor: flow
  • Lib: React
  • Formatter: prettier-standard
  • Linter: standard
  • Bundler: Webpack 4
  • Git-hooks: husky
  • Styles: Emotion JS

See the Storybook

📖 Development scripts

It required the environment variable API_BASE, please set it before running the project 😉

yarn install

Install the dependencies

yarn dev

Run in development mode

eg: API_BASE=http://localhost:3000 yarn dev

yarn prod

Build the project

yarn flow

Run the typechecker

yarn lint:fix

Check and fix code in accordance with linting rules (standard)

yarn prettier

Formats the code, then run lint:fix

yarn storybook

Run storybook in development mode

yarn build-storybook

Build the storybook

Contributing

Read more here

New issues for features, enhancements, bugs or suggestions are welcome!

License

The source code is licensed under MIT. License is available here


Made with 😝 by @akatsukijs