Introduction

The Adamik application is a boilerplate implementation of the main Adamik API endpoints. It serves as a starting point for developers looking to integrate with the Adamik API, providing essential functionalities and example usages of the API. As a truly open-source project licensed under the MIT License, Adamik encourages community contributions and collaboration.

Useful links

• Adamik website
• Adamik Developer Documentation
• Adamik Demo Application
• Discord

Table of Contents

• Getting Started
• Prerequisites
• Installation
• Contributing
• License

Getting Started

The Adamik Application is a Next.js project bootstrapped with create-next-app.

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have the following installed on your development machine:

• Node.js
• pnpm

Installation

1. Clone the repo

   git clone https://github.com/your-username/adamik-app.git

2. Install dependencies

   cd adamik-app
   pnpm install

3. Get your API key if you don't already have one and set it in a file named .env.local at the root of the project.

   You will also need a Mobula API key to retrieve the prices, logos and tickers of assets.

   NEXT_PUBLIC_ADAMIK_API_TEST_URL="https://api.adamik.io/api"
   ADAMIK_API_KEY="<your Adamik API key>"
   MOBULA_API_KEY=""<your Mobula API key>"
   

Running the Development Server

First, run the development server:

pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Contributing

Any contributions you make to the Adamik App are greatly appreciated. Feel free to also contact us through Discord to report bugs or express feature requests.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.