-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
30 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters