Skip to content

Shaarps/starknet.quest

 
 

Repository files navigation

Starknet Quest Client

Leading quests platform on Starknet to onboard your next million users. We provide a platform for users to discover new apps and for companies to pitch your products and new features to users and get user feedback.

Pull Requests welcome

About

Starknet Quest helps protocols attract and retain users by creating gamified quest experiences on Starknet.

Terms to help you get familiar with codebase -

Quests

  • A Quest is a set of tasks which a user can do. On completing a quest they are eligible to get an NFT as proof of completion and possible tokens as a reward.
  • Each Quest is created by one of the leading Dapps on starknet and are reviewed by the maintainers on the repo before publishing on the application.

Achievements

  • An achievement are another type of tasks which are milestone based and long term.
  • Each Achievement has certain milestones within them and on completing them they get rewarded with a building on the Starknet Quest Land (explained below)

Land

  • Your land is the visual representation of your on-chain reputation which grows in size as you complete more quests and achievements on the platform.
  • You can visit this to check your overall progress on the starknet quest platform and expand it by completing any new quests or achievements.

How to get started

Fork the repository and clone the forked repository to your local system

git clone https://github.com/starknet-id/starknet.quest.git

Install dependencies and run the development build

npm i
npm run dev

If you encounter installation issues, try these steps:

  • Clear npm cache: npm cache clean --force
  • Delete node_modules: rm -rf node_modules
  • Delete package-lock.json: rm package-lock.json
  • Retry installation: npm i

If issues persist, you can try npm i --legacy-peer-deps or npm i --force as a last resort.

Note that using these flags may lead to dependency conflicts.

You should see something like this:

> [email protected] dev
> next dev

   ▲ Next.js 14.1.0
   - Local:        http://localhost:3000
   - Environments: .env

 ✓ Ready in 1431ms

🤝 Contribute

We're always looking for passionate developers to join our community and contribute to Starknet Quest. Check out our contributing guide for more information on how to get started.

To connect with us regarding any queries about contributing to the repo, feel free to join our telegram group here

Adding yourself as a contributor

If you've contributed to this project, you can easily add yourself to the contributors list by commenting on any issue or pull request with: @all-contributors please add <your-github-username> for <contribution-type>

For example: @all-contributors please add @fricoben for code, doc, business, and ideas

For a full list of contribution types, check out the emoji key.

Contributors ✨

Thanks go to these wonderful people:

Fricoben
Fricoben

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

The on-chain quest tool of Starknet

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 70.8%
  • JavaScript 18.3%
  • CSS 10.9%