https://github.com/harsh-2711/crypto-manager

Live Deployment
https://github.com/harsh-2711/crypto-manager

Last synced: 24 days ago
JSON representation

Live Deployment

• Host: GitHub
• URL: https://github.com/harsh-2711/crypto-manager
• Owner: harsh-2711
• License: mit
• Created: 2020-02-16T19:09:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T03:46:28.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T15:44:14.215Z (over 1 year ago)
• Language: JavaScript
• Homepage: http://crypto-manager-2-dev.us-east-1.elasticbeanstalk.com
• Size: 4.83 MB
• Stars: 4
• Watchers: 2
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# crypto-manager

[![Build Status](https://travis-ci.com/harsh-2711/crypto-manager.svg?branch=master)](https://travis-ci.com/harsh-2711/crypto-manager)

## Installation

- Clone the repo: `git clone https://github.com/harsh-2711/crypto-manager.git && cd crypto-manager`

#### For starting backend APIs:

- Go to `api` directory: `cd api`

- Create a virtual environment (optional): `virtualenv venv`

    - If virtual environment package is not installed, first do: `pip install virtualenv`

- Start virtual environment: `source venv/bin/activate`

- Install dependencies: `pip install -r requirements.txt`

- Get your api keys from [Crypto Compare](https://min-api.cryptocompare.com/pricing) and [Nomics](https://p.nomics.com/cryptocurrency-bitcoin-api)

- Create a `.env` file in the `api` folder and paste the api keys: `touch .env && echo CRYPTO_API_KEY= >> .env && echo NOMICS_API_KEY= >> .env`

#### Starting the project

- Head over to main project directory

- Install NodeJs from [NodeJs Official Page](https://nodejs.org/en).

- Install node dependencies: `npm install`

- Start frontend: `npm start`

- Start backend: `yarn start-api` or `npm run start-api`

- Navigate to `http://localhost:3000/`

- (optional) Run in terminal `npm i -g cross-env`

## Tests

#### Frontend tests

For testing react components and functions,

- Head over to root directory

- Write `npm test` in terminal

For adding new frontend tests, go to `__tests__` folder in `src` directory. Please follow the below convention to add new test files -

- For adding component tests - `.test.js`

- For adding functional tests - `_.test.js`

- For adding unit tests - `_unit.test.js`

#### Backend tests

For testing flask server and API endpoints,

- Head over to root directory OR into `api` folder

- Write `pytest` in terminal

For adding new backend tests, go to `tests` folder in `api` directory. Please follow the below convention to add new test files -

- For adding functional tests - `test_functional_.py`

- For adding unit tests - `test_unit.py`

### Architecture

![Architecture](https://github.com/harsh-2711/crypto-manager/blob/master/deployment-diagram/architecture.jpeg)