diff --git a/Readme.md b/Readme.md index 5e6f559..1d4b243 100644 --- a/Readme.md +++ b/Readme.md @@ -1 +1,266 @@ -# Hype The Hike \ No newline at end of file +# HACK THE MOUNTAINS 3.0 - Hype The Hike + + +
+
+ + Logo + + +

Hype the Hike - Community Driven tourism

+ +

+ Use this readme for getting stared with this project +
+ docs » +
+
+ Blog + . + Live + · + Report Issues + · + Request Feature +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgments
    9. +
+
+ + + + +## About The Project +### Screenshots +
+ +![pg12 png](https://user-images.githubusercontent.com/63441472/190886473-d047ad42-00d4-4f1a-82f9-fb357e3c14d9.jpg) + +
+ + +### Inspiration: +- Currently, the ticketing system can't help people reflect on special moments from past events. Hence, NFTs have arrived to make tickets more functional and easy to collect for memories. +- A tradition-based ticket may be lost or destroyed. +- Organizers do not get enough security with paper-based tickets thus they can be easily faked. +- With NFTs, you don't need to compromise anymore and the technology benefits both the organizers and users. + +### What it does: +- Empowers Community Driven tourism +- In The landing Page user will be able to see **upcoming events, features of our DAPP and contact us section**. +- To join an event, user need to sign-in using **Arcana Auth**. +- To Join A community , User need to go to the **"Join Us"** Sections where all the upcoming events are listed. +- User can select their prefered event ,then choose the activity , after that the user needs to connect **Metamask Wallet** to Mint their NFT which will act as their identity proof for rest of the event. +- **ThirdWeb SDK** is used to mint NFTs. +- We Used **LightHouse** to store the images of NFTs in **IPFS** network instead of centralized database system. + +### Challenges we ran into: + - **ThirdWeb** is not compatible with Webpack so we had to migrate our codebase in middle of the hackathon. + - **Arcana's SDKs** and **ThirdWeb SDK** were not build for production so we had to face a lot of bugs. + - We had trouble adding metadatas to NFT. + +### What's Next For Our Project: +- **NFT Marketplace** where one can sell their best travel photographs as NFTs. +- Private NFT using **Arcana**. +- **Expanding for families** too to join us for enjoying the beauty of nature. + +

( +back to top)

+### What it does + + +### Built With + + + +- **React** - for building the frontend UI
+- **Vite** - as Module bundler instead of webpack
+- **Lighthouse**- as __IPFS__ Storage
+- **Arcana**- for Authentication and storage
+- **Thirdweb** - for Minting NFTs and providing with a marketplace
+- - Build on Top of **Polygon** chain
+- - Deployed in **Spheron** + + + + + + +

(back to top)

+ + + + +## Getting Started +For setting up your project locally, follow these simple steps. + +### Prerequisites + +You must have NPM(Node Package Manager) installed in your system , If you dont we got you covered + + + [Install NPM](https://phoenixnap.com/kb/install-node-js-npm-on-windows) + + +### Installation + +_How to setup this project_ + +1. Clone the repo + ```sh + git clone https://github.com/IRSHIT033/Hype-The-Hike.git + ``` +3. Install all the NPM packages + ```sh + npm install + ``` +4. Create a wallet.json file and add your public and private key + ```json + { + "privateKey": "", + "publicKey": "" + } + ``` + Then import wallet using the private key, use the following command + ```sh + lighthouse-web3 import-wallet ./wallet.json + ``` +5 run + ```sh + npm start dev + ``` +

(back to top)

+ + + + + + + + +## Roadmap +  +- [x] landing page +- [x] Recent Events +- [x] Login using Arcana +- [x] Join Us / Activity Section +- [x] Mint NFT upon joining +- [x] NFT ticketing +- [x] Intigrate Lighthouse IPFS +- [ ] Private NFT +- [ ] NFT Marketplace + + + +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues). + +

(back to top)

+ + + + +## Contributing + + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "improvement". +Don't forget to star this project!! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/Feature1`) +3. Commit your Changes (`git commit -m 'Add Feature 1'`) +4. Push to the Branch (`git push origin feature/Feature1`) +5. Open a Pull Request + +

(back to top)

+ + + + +## License + +Distributed under the MIT License + +

(back to top)

+ + + + +

(back to top)

+ + + + +## Acknowledgments + +Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off! + + +* [NPM](https://www.npmjs.com/) +* React icons + +

(back to top)

+ + + + + +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/othneildrew +[product-screenshot]: images/screenshot.png +[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white +[Next-url]: https://nextjs.org/ +[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB +[React-url]: https://reactjs.org/ +[Node.js]: https://img.shields.io/badge/Node.js-35495E?style=for-the-badge&logo=nodedotjs&logoColor=4FC08D +[Vue-url]: https://vuejs.org/ +[Express]: https://img.shields.io/badge/Express-35495E?style=for-the-badge&logo=express&logoColor=white +[Angular-url]: https://angular.io/ +[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 +[Svelte-url]: https://svelte.dev/ +[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white +[Laravel-url]: https://laravel.com +[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white +[Bootstrap-url]: https://getbootstrap.com +[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white +[JQuery-url]: https://jquery.com