feat: add readme

.env.example

@@ -1,4 +1,4 @@
-NEXT_PUBLIC_API_LINK=http://0.0.0.0:8080
+NEXT_PUBLIC_API_LINK=https://goerli.api.starknet.quest
 NEXT_PUBLIC_IS_TESTNET=true
 NEXT_PUBLIC_STARKNET_ID=https://goerli.starknet.id
 NEXT_PUBLIC_APP_LINK=http://localhost:3000

.gitignore

@@ -36,7 +36,4 @@ yarn-error.log*
 
 # typescript
 *.tsbuildinfo
-next-env.d.ts
-
-package-lock.json
-yarn.lock
+next-env.d.ts

README.md

@@ -1 +1,71 @@
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<div align="center" style="margin-top:50px">
+  <img src="public/visuals/starknetquest.webp" height="300">
+</div>
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
 # 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](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/starknet-id/starknet.quest/issues?q=is:issue+is:open+label:%22open+for+contribution%22)
+
+## About
+
+Starknet Quest is a platform which helps users to interact with a variety of Starknet Dapps and play around with them and get rewarded for it. We also help companies building on the Starknet ecosystem a platform to pitch their new features and products to the Starknet users.
+
+## How it works
+
+### Some things to help you get familiar with the codebase
+
+#### Quests
+
+* A Quest is a set of tasks which a user can do. On completing a quest they are eligible to get a NFT 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
+
+* Lands is a kingdom you build 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 platfrom and expand it by completing any new quests or achievements which come on the platform
+
+
+## How to get started
+
+Clone the repository
+```bash
+git clone https://github.com/starknet-id/starknet.quest.git
+```
+
+
+Install dependencies and run the development build
+
+```bash
+npm i
+npm run dev
+```
+
+You should see something like this:
+
+```sh
+> starknet-id-website@0.1.0 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](./docs/CONTRIBUTING.md)
+for more information on how to get started.
+

docs/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish
+to make via issue, email, or any other method with the owners of this repository
+before making a change.
+
+## Development environment setup
+
+
+To set up a development environment, please follow these steps:
+
+   ```sh
+   git clone https://github.com/starknet-id/starknet.quest.git
+   cd starknet.quest
+   npm i && npm run dev
+   ```
+
+## Issues and feature requests
+
+You've found a bug in the source code or maybe
+you'd like a new feature?
+You can help us by
+[submitting an issue on GitHub](https://github.com/starknet-id/starknet.quest/issues).
+Before you create an issue, make sure to search the issue archive -- your issue
+may have already been addressed!
+
+Please try to create bug reports that are:
+
+- _Reproducible._ Include steps to reproduce the problem.
+- _Specific._ Include as much detail as possible: which version, what
+  environment, etc.
+- _Unique._ Do not duplicate existing opened issues.
+- _Scoped to a Single Bug._ One bug per report.
+
+**Even better: Submit a pull request with a fix or new feature!**
+
+### How to submit a Pull Request
+
+1. Search our repository for open or closed
+   [Pull Requests](https://github.com/starknet-id/starknet.quest/pulls) that
+   relate to your submission. You don't want to duplicate effort.
+2. Fork the project
+3. Create your feature branch (`git checkout -b feat/amazing_feature`)
+4. Commit your changes (`git commit -m 'feat: add amazing_feature'`)
+5. Push to the branch (`git push origin feat/amazing_feature`)
+6. [Open a Pull Request](https://github.com/starknet-id/starknet.quest/compare)
+
+#### Understanding and using correct labels on your Pull Request
+
+- If your PR is ready for review or merging then add a label which says - **Ready for Review**
+- If your PR is in progress and is not ready for review or merging then add a label which says - **In progress do not merge**
+- If the maintainer has reviewed and has asked for a change then they would attach the label - **Changes Requested**.  You can remove this label and replace with the **Ready for review** label once you resolve all the review comments made by the reviewer.