/epikrypto

Epicodus Team Week project # 1

Primary LanguageHTML

Epikrypto

Information page about different cryptocurrencies.

Team Members

  • Alejandra Goldberg-Dominguez
  • DeAunt'e Hall
  • Mary Marks
  • Carlos Urquiza

Technologies Used

  • HTML
  • CSS
  • Bootstrap
  • JavaScript
  • jQuery
  • Git
  • GitHub Pages
  • webpack
  • CryptoCompare API
  • YouTube iFrame

Description

Information page about different cryptocurrencies, its history and the future of cryptocurrency in developing nations. This page provides the following information:

  • Live up-to-date cryptocurrency pricing
  • Relevant news articles
  • Use of the CryptoCompare API
  • Informational video about cryptocurrency mining

Setup/Installation Requirements

  • Clone this repository. To clone using HTTPS, click on the green download button above the list of files and click on the clipboard icon to save the repository URL. Clone button

  • Open your terminal.

  • Navigate to the directory (such as your Desktop) where you want the cloned directory.

  • Type git clone and paste the URL you copied.

  • Press Enter.

  • Navigate to the project folder on your computer.

  • Recreate project environment by running $ npm install.

  • Visit the CryptoCompare API site to get a free API key.

  • Click on Get your free API Key.

  • Click on SIGNUP button and enter your email address and password.

  • Click the Signup button under the Password section.

  • Once your CryptoCompare API is activated, copy your API key.

  • Create a .env file in the top level of your project.

  • Store your API key as API_KEY={API key goes here} within your .env file.

  • Run $ npm run build to open project via a development server.

  • View project using development server by running $ npm run start.

  • Alternatively, you can view the live webpage via this GitHub Page. You will still require an API key to use.

Known Bugs

  • Our current API implementation only returns a success message to the DOM, but current state doesn't populate any other results. The user will have to check their console for results.

License

MIT License

Copyright (c) 2021

Alejandra Goldberg-Dominguez | DeAunt'e Hall | Mary Marks | Carlos Urquiza

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contact Information

Feel free to contact alexdominguezwebdev@gmail.com, godsofolympus88@gmail.com, maryleemarks@gmail.com or webquiza@gmail.com with any questions regarding this webpage.