Skip to content

CryptoCanons - the final project of Le Wagon Web Development batch #676. Built in Ruby on Rails.

Notifications You must be signed in to change notification settings

Sajakhtar/cryptocanons

Repository files navigation

Welcome 👋 to CryptoCanons

  1. About
  2. Features
  3. Screenshots
  4. Demo and Pitch
  5. Roadmap
  6. Installation
  7. Usage
  8. Authors and Contributors
  9. License

About

CryotoCanons is a Cryoto news and price curator web app.

It was developed in 2 weeks as the final project for batch #676 of the Le Wagon Web Development Bootcamp in Dubai.

CryotoCanons is a Ruby on Rails web app that uses a base template from lewagon/rails-templates, created by the Le Wagon team.

Currently it was designed to be mobile only, but will be updated to be fully responsive.


Features

CryotoCanons feature set currently consists of

  • User authentication and accounts
  • Search for cryptocurrencies or crypto topics e.g. DeFi, NFT to view curated tweets and price for that currency/ topic
  • Add the currency/ topic to your favorites
  • A dashboard to view your favorite topics
  • View the tweets, price and price chart for a saved topic/currency
  • Bookmark tweets - this will annotate the chart
  • Delete a favorite topic

Screenshots

homepage search results topics dashboard topic page

Demo and Pitch


Roadmap

  • Desktop friendly design
  • Convert to PWA
  • Add Market cap charts
  • Add the ability to place trades/ invest directly from the platform

Tools

Languages and Tools utilized in this project


ruby rails javascript css3 bootstrap git postgresql heroku

JavaScript Plugins

APIs


Schema

homepage
___ ## Installation

Setup data schema and database locally with seed data

rails db:migrate

rails db: seed

To install Ruby Gems and JavaScript plugins:

bundle install

yarn install

Environment variables:

  • Twitter API v2 bearer token
  • CoinmarketCap API key

Usage

To run in localhost:3000

rails s

Authors and Contributors

Sajid Akhtar

Khamza Habibullah

Octavian Serban

Lanre Fabunmi

With special thanks to Tarig Bouazzati and Andre R Ferrer for the teaching, mentoring and general support during the project.

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.


License

MIT