Giter Club home page Giter Club logo

backend-coin-lift's Introduction

Backend for CoinLift.

This project is called CoinLift and involves the development of a backend system for a cryptocurrency application. The team consists of one backend developer, three frontend developer, and three designers.

The repository in which I continue to develop this project -> LINK

Documentation:

Swagger Docs -> LINK

Getting Started

  1. Clone the repository to your local machine.
  2. Ensure that you have Docker and Docker Compose installed on your system. And run this command in you terminal:
docker-compose up -d
  1. Add JWT secret key in the application.yml file:
jwt:
  secret: <YOUR_OWN_SECRET_KEY>
  1. Set up AWS S3 buckets by creating a ~/aws directory in your terminal (INSTRUCTION) and configuring the following settings in the application.yml file:
aws:
  region: <AWS_REGION>
  s3:
    buckets:
      customer: <BUCKET_NAME>
  1. Obtain the API keys from CoinMarketCap and Coindesk (instructions below).
  2. Add the API keys to the Spring Boot project by updating the application.yaml file:
coinmarketcap:
  api:
    key: <YOUR_API_KEY>

rapid:
  coindesk:
    api:
      key: <YOUR_API_KEY>
  1. Save the application.yaml file and restart the Spring Boot application.
  2. Build the project by running mvn clean package.
  3. Run the project by running java -jar target/backend-1.jar.

Instruction for obtaining API Keys from CoinMarketCap and Coindesk

Obtaining a CoinmarketCap API Key

  1. Go to the CoinMarketCap website and sign up for an account, or log in if you already have one.
  2. Once you are logged in, navigate to the API page by clicking on the "API" link in the top menu.
  3. Choose a plan that suits your needs and click the "Subscribe" button to proceed to the next step (For this tutorial, we will be using a free plan).
  4. Enter your billing information and click the "Continue" button to complete the subscription process. Note that some plans require payment, while others are free.
  5. Once you have subscribed to a plan, you will receive an API key, which you can use to access the CoinMarketCap API.

Adding the API Key to a Spring Boot Project

  1. Open the application.yaml file of this Spring Boot project, located in the src/main/resources directory.
  2. Add the following line to the file, replacing <YOUR_API_KEY> with the API key you obtained from CoinMarketCap:
coinmarketcap:
    api:
       key: <YOUR_API_KEY>

Obtaining a Coindesk API Key

  1. Go to the RAPID API page and sign up for an account, or log in if you already have one.
  2. Once you are logged in, navigate to the Cryptocurrency News API page by searching on website or by clicking this LINK.
  3. Choose a plan that suits your needs and click the "Subscribe" button to proceed to the next step (For this tutorial, we will be using a free plan).
  4. Fill in the required information and click the "Submit" button to complete the subscription process. Note that some plans require payment, while others are free.
  5. Once you have subscribed to a plan, you will receive an API key, which you can use to access the Coindesk API.

Adding the API Key to a Spring Boot Project

  1. Open the application.yml file of this Spring Boot project, located in the src/main/resources directory.
  2. Add the following lines to the file, replacing <YOUR_API_KEY> with the API key you obtained from Coindesk:
rapid:
  coindesk:
    api:
      key: <YOUR_API_KEY>

Please make sure to replace <OWN_SECRET_KEY>, <AWS_REGION>, <BUCKET_NAME>, <YOUR_COINMARKETCAP_API_KEY>, and <YOUR_COINDESK_API_KEY> with the actual values you want to use.

backend-coin-lift's People

Contributors

vladsw764 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.