Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
puncsky authored Jan 31, 2021
1 parent 45794b0 commit 6d11270
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
# web-onefx-boilerplate
# launch-room

[![CircleCI](https://circleci.com/gh/puncsky/web-onefx-boilerplate/tree/master.svg?style=svg)](https://circleci.com/gh/puncsky/web-onefx-boilerplate/tree/master)

- [Documentation](https://onefx.js.org/doc.html?utm_source=github-iotex-explorer)
- [Contributing](https://onefx.js.org/contributing.html?utm_source=github-iotex-explorer)
## User guide

Launch Room is a feature flag service that is lightweight and compatible with LaunchDarkly client.

[User guide](https://stargately.com/docs/launch-room): How to integrate your service with launch-room?

## Getting Started
![](https://tp-misc.b-cdn.net/launch-room-01.png)
![](https://tp-misc.b-cdn.net/launch-room-02.png)

OneFx is a full-stack framework for building web apps. Here are the features you'll find in Onefx.js:
## Development

- server side rendering and universal rendering with react and redux
- ES2017, JSX, TypeScript support out of the box
- server-side development via Koa.js
All the descriptions below are for the development of launch-room itself.

- [Documentation](https://onefx.js.org/doc.html?utm_source=github-iotex-explorer)
- [Contributing](https://onefx.js.org/contributing.html?utm_source=github-iotex-explorer)

### Create a project

```bash
git clone git@github.com:puncsky/web-onefx-boilerplate.git my-awesome-project
git clone git@github.com:puncsky/launch-room.git
```

### Run your project

This is intended for \*nix users. If you use Windows, go to [Run on Windows](#run-on-windows). Let's first prepare the environment.

```bash
cd my-awesome-project
cd launch-room

nvm use 10.15.0
nvm use 10.23.0
npm install

# prepare environment variable
Expand Down

0 comments on commit 6d11270

Please sign in to comment.