Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: enhanced the readme with addition of yarn setup steps #456

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,32 @@ npm install -g yarn

### Installation

#### Yarn Setup

To run the Vue app locally, you can follow the below procedure:

1. Clone [FLINT.UI](https://github.com/moja-global/FLINT-UI) repository:

```shell
git clone https://github.com/<username>/FLINT-UI
```
2. Go to the flint.ui folder and run yarn install.
```shell
cd flint.ui
yarn install
```

3. Run yarn serve to start the Vue app server.
```shell
yarn serve
````

4. Go to 127.0.0.1:8000 to view the Vue app.



#### Docker Setup

To set up this project locally follow the below procedure:

1. Pull the below docker image to run `flint.example`:
Expand Down