Skip to content

Commit

Permalink
[demo] refactor: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Envoy-VC committed Dec 28, 2023
1 parent 295a8f8 commit 90d5953
Showing 1 changed file with 21 additions and 42 deletions.
63 changes: 21 additions & 42 deletions apps/demo/README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,39 @@
# 🛫 Web3 Hackathon Starter
# Atomic Toolkit Demo App

The Web3 Hackathon Starter Kit, or w3-starter, is a web3 dApp template designed to simplify the process of building hackathon projects. By eliminating unnecessary boilerplate code, this opinionated template allows you to focus on the core functionality of your project. This is my go to template for hackathons and I hope you find it useful as well.
Welcome to the Atomic Toolkit Demo App! This application showcases the capabilities of the Atomic Toolkit package, providing a hands-on experience with deploying based on atomic standards on Arweave.

---
## Getting Started

## 🧰 Tech Stack

1. [Create T3 App](https://create.t3.gg/): The Web3 Hackathon Starter Kit is bootstrapped with Create T3 App, which ensures type safety throughout the project. It also includes additional packages like [@t3-oss/env-nextjs](https://env.t3.gg/) for easy management of environment variables.
2. [Tailwind CSS](https://tailwindcss.com/): This template uses Tailwind CSS as a lightweight CSS framework, for efficient styling.
3. [next-themes](https://github.com/pacocoursey/next-themes): To enable theme switching between dark and light themes, the template uses next-themes as a theme provider.
4. [zod](https://zod.dev/): For form validation, a lightweight library that provides type validation for forms.
5. [zustand](https://docs.pmnd.rs/zustand/getting-started/introduction): To manage the application's state, this template uses zustand, a minimalistic state management library for React.
6. [Ant Design](https://ant.design/): The Web3 Hackathon Starter Kit integrates ant design, a comprehensive UI component library, to facilitate the development of a visually appealing user interface.
7. [react-icons](https://react-icons.github.io/react-icons): This template includes react-icons, a popular library that provides a wide range of icons for use in your project.
8. [react-hot-toast](https://react-hot-toast.com/): For displaying toast notification messages, this Starter Kit uses react-hot-toast, a lightweight and customizable toast library.
9. [next-seo](https://github.com/garmeeh/next-seo): To optimize your project for search engines, this template utilizes next-seo as an SEO provider.

---

## 🚀 Getting Started

To get started with the Web3 Hackathon Starter Kit, follow these simple steps:

1. Clone the Repository: Begin by cloning the w3-starter repository to your local machine using the following command:
Follow these steps to set up and run the demo app:

1. **Clone the Repository:**
```bash
git clone -b basic https://github.com/Envoy-VC/web3-hackathon-starter.git
git clone https://github.com/Envoy-VC/atomic-toolkit.git
cd atomic-toolkit/apps/demo
```

or click on the use as template button to create a new repository from this template.

2. Install Dependencies: Navigate to the cloned repository and install the required dependencies by running the following command:
2. **Install Dependencies:**
```bash
pnpm install
```

3. Run the Project: Once you have installed the dependencies, you are ready to run the project. To start the development server, run the following command:

3. **Run the App:**
```bash
pnpm run dev
pnpm run dev
```
4. **Access the App::**
```bash
open http://localhost:3000
```

---

Customize Your Project: Open the project in your preferred code editor and customize it according to your hackathon project requirements. Feel free to modify the existing files or add new ones as needed.

---
## Features

## Contributing 🤝
1. **Atomic Asset Functions**: Explore functions related to creating and fetching atomic assets.
2. **Collection Functions**: Utilize functions related to creating and fetching collections.
3. **GraphQL Functions**: Fetch data from the Arweave GraphQL API seamlessly.

Contributions are welcomed. If you encounter any issues or have suggestions for improvements, please submit them via GitHub issues. Additionally, feel free to fork the repository and submit pull requests with your enhancements.
## Contributing

---
If you'd like to contribute to the Atomic Toolkit Demo App, please follow our [contribution guidelines](../../contributing.md).

## License

The Web3 Hackathon Starter Kit is open source software licensed under the MIT License. Please see the [LICENSE](./LICENSE)

---
This project is licensed under the [MIT License](../../LICENSE), making it open and accessible for everyone.

0 comments on commit 90d5953

Please sign in to comment.