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
Swagger Docs -> LINK
- Clone the repository to your local machine.
- Ensure that you have Docker and Docker Compose installed on your system. And run this command in you terminal:
docker-compose up -d
- Add JWT secret key in the application.yml file:
jwt:
secret: <YOUR_OWN_SECRET_KEY>
- 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>
- Obtain the API keys from CoinMarketCap and Coindesk (instructions below).
- 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>
- Save the application.yaml file and restart the Spring Boot application.
- Build the project by running
mvn clean package
. - Run the project by running
java -jar target/backend-1.jar
.
- Go to the CoinMarketCap website and sign up for an account, or log in if you already have one.
- Once you are logged in, navigate to the API page by clicking on the "API" link in the top menu.
- 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).
- Enter your billing information and click the "Continue" button to complete the subscription process. Note that some plans require payment, while others are free.
- Once you have subscribed to a plan, you will receive an API key, which you can use to access the CoinMarketCap API.
- Open the application.yaml file of this Spring Boot project, located in the src/main/resources directory.
- 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>
- Go to the RAPID API page and sign up for an account, or log in if you already have one.
- Once you are logged in, navigate to the Cryptocurrency News API page by searching on website or by clicking this LINK.
- 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).
- 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.
- Once you have subscribed to a plan, you will receive an API key, which you can use to access the Coindesk API.
- Open the
application.yml
file of this Spring Boot project, located in thesrc/main/resources
directory. - 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.