From dff85f667b544fb9e203bada752faf0ada0019e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rolo=20=F0=9F=90=89?= <55175623+RolandoDrRobot@users.noreply.github.com> Date: Sun, 20 Oct 2024 15:43:30 -0600 Subject: [PATCH] Update README.md --- README.md | 69 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 9473c32..5a2c9d3 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com: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