Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RolandoDrRobot authored Oct 20, 2024
1 parent ef02269 commit dff85f6
Showing 1 changed file with 3 additions and 66 deletions.
69 changes: 3 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,3 @@
# ArkMarket

[ArkProject](https://www.arkproject.dev) marketplace template using the [T3 Stack](https://create.t3.gg) & [Turborepo](https://turborepo.org). See live demo at [market.arkproject.dev](https://market.arkproject.dev).

## About

Here’s the monorepo structure:

```text
apps
├─ arkmarket
packages
├─ ui
tooling
├─ eslint
├─ prettier
├─ tailwind
└─ typescript
```

The `apps` directory contains the code for:

- arkmarket: ArkMarket's web application ([market.arkproject.dev](https://market.arkproject.dev)).

The `packages` directory contains the code for:

- `ui`: UI component library, using [shadcn](https://ui.shadcn.com).

The `tooling` directory contains the code for:

- `eslint`: ESlint presets.
- `prettier`: Prettier presets.
- `tailwind`: Tailwind presets.
- `typescript`: Typescript configuration.

> We use `@ark-market` as a placeholder for package names. You might want to replace it with your own organization or project name. You can use find-and-replace to change all the instances of `@ark-market` to something like `@my-company` or `@project-name`.
## Template

> We use `@ark-market` as a placeholder for package names. You might want to replace it with your own organization or project name. You can use find-and-replace to change all the instances of `@ark-market` to something like `@my-company` or `@project-name`.
## Local setup

Clone the repo:

```bash
git clone [email protected]:ArkProjectNFTs/ark-market.git
```

Install dependencies:

```bash
pnpm i
```

Configure environment variables:

```bash
cp .env.example .env
```

Start arkmarket application:

```bash
pnpm dev
```
# ByteBeasts Marketplace
- This is a work in progress project
- For Onlydust: This will be available for onlydust in the near future

0 comments on commit dff85f6

Please sign in to comment.