Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelis0x committed Feb 5, 2025
1 parent 8199828 commit 2f16aa3
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 39 deletions.
54 changes: 24 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,46 @@
# Enso shortcuts UI monorepo
# Enso templates monorepo

This is a monorepo project that includes multiple packages and applications. The project uses TypeScript, React, and several other libraries and tools.
This project is home of Enso mini-apps. It is structured as a monorepo that includes multiple packages and applications. The project uses TypeScript, React, and several other libraries and tools.

## Project Structure

- `apps/feeling-lucky`: Contains example mini-app
- `packages/sdk`: Contains the SDK used by mini-apps
- `apps/feeling-lucky`: Contains simple swap app that allows users to ape into random token from selected sector for amount and token of their choice
- `packages/*`: Contains helper functions used by mini-apps

## Getting Started

### Prerequisites

- Node.js
- Yarn
- pnpm

### Installation

1. Clone the repository:
```sh
git clone <repository-url>
cd <repository-directory>
```
```sh
git clone <repository-url>
cd <repository-directory>
```

2. Install dependencies:
```sh
yarn install
```
```sh
pnpm install
```

### Running the Application
3. Set up environment variables before running specific apps:
```sh
cd apps/feeling-lucky
cp .env.example .env
```

1. Start the development server:
```sh
yarn sdk:dev
yarn fl:dev
```

### Building the SDK
### Running an Application

1. Navigate to the SDK directory:
```sh
cd packages/sdk
```

2. Build the SDK:
```sh
yarn build
```
1. Start the development server:
```sh
cd apps/feeling-lucky
pnpm dev
```

## License

This project is licensed under the MIT License.
This project is licensed under the MIT License.
4 changes: 2 additions & 2 deletions apps/feeling-lucky/.env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
NEXT_PUBLIC_ENSO_API_KEY=
NEXT_PUBLIC_COINGECKO_KEY=
NEXT_PUBLIC_PRIVY_KEY
NEXT_PUBLIC_PRIVY_KEY=
NEXT_PUBLIC_BASE_PATH=
6 changes: 2 additions & 4 deletions apps/feeling-lucky/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

#### Cannot decide where to ape in? Feeling lucky is here to help you out.

It allows users to ape into random meme for amount and token of their choice.
Gets use of `@ensofinance/sdk` to access API. Showcases a way to easily implement a telegram mini-app utilizing `Privy` functionality
The app allows users to ape into random token from selected sector for amount and token of their choice.
it uses React, Next.js, Wagmi, Privy, Chakra-UI, and `@ensofinance/sdk-ts` to access Enso API.

### Main file page.tsx

Expand Down Expand Up @@ -41,6 +41,4 @@ Gets use of `@ensofinance/sdk` to access API. Showcases a way to easily implemen
### Environment Variables

- **NEXT_PUBLIC_ENSO_API_KEY**: API key for Enso Finance.
- **NEXT_PUBLIC_COINGECKO_KEY**: API key for CoinGecko.
- **NEXT_PUBLIC_PRIVY_KEY**: API key for Privy.
- **NEXT_PUBLIC_ONE_INCH_API_KEY**: API key for 1inch.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"scripts": {
"fl:dev": "pnpm --filter @ensofinance/feeling-lucky dev"
"fl:dev": "pnpm --filter feeling-lucky dev"
},
"name": "ense-apps-monorepo",
"name": "enso-apps-monorepo",
"version": "1.0.0",
"main": "index.js",
"repository": "[email protected]:EnsoFinance/shortcuts-ui-examples.git",
Expand Down
1 change: 0 additions & 1 deletion packages/shared/util.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,3 @@ export const formatNumber = (value: number | string, precise?: boolean) => {
export const formatUSD = (value: number | string) => {
return usdFormatter.format(+value);
};

0 comments on commit 2f16aa3

Please sign in to comment.