tiago-web / Crypto-Portfolio

Crypto Portfolio

This project aims to create a portfolio that stores the tokens the user with the update amount in USD.

---

---

📌 Table of Contents

• Features
• Dependencies
• Getting Started
• Documentation
• Testing
• FAQ

🔗 Features

• 📈 Retrieve the updated currency of the user's tokens.
• 📋 Save and Remove tokens to the portfolio

🔒 Dependencies

To run this script you need to install locally on your machine the following dependencies:

• NodeJS
• Docker
• Docker Compose

🏁 Getting Started

Clone the project via HTTPS by running this command:

git clone https://github.com/tiago-web/starter_assignment.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone [e-mail]:tiago-web/starter_assignment.git

Run the following command in order to install the dependencies and start the whole application in a development environment:

cd backend

Then:

yarn startup or npm run startup

If the project runs successfully you should be able to access it on:

http://localhost:3000

📃 Documentation

Backend

With your backend running, you should be able to access the documentation on:

http://localhost:3333/docs

Frontend

cd frontend

Then:

yarn storybook or npm run storybook

After these commands, you should be able to access the documentation on:

http://localhost:6006

🐛 Testing

In order to test the application, you should run the following command:

Backend

cd backend

Then:

yarn test or npm run test

Frontend

cd frontend

Then:

yarn test or npm run test

📮 FAQ

Question: What are the technologies used in this project?

Answer: The tecnologies used in this project are:

• React
• Material UI
• TypeScript
• MongoDB
• NestJS
• Node.js
• Docker