README

Crypto Voting Project

https://cryptovotingproject-cc7f6a61a180.herokuapp.com/

Table of Contents

1. Introduction
2. Core Features
3. Objectives
4. Technologies Used
5. Setup and Installation
6. Usage
7. Contributors
8. License
9. Additional Links

Introduction

Crypto Voting Project is a community-driven platform for cryptocurrency enthusiasts. It combines real-time market analysis, sentiment voting, and vibrant discussions, addressing the need for an interactive space in the rapidly expanding crypto market.

Live Application on Heroku

---

Core Features

• Dashboard: Displays real-time cryptocurrency data and dynamic charts using APIs like CoinGecko and TradingView.
• Sentiment Voting: Users can vote Bullish or Bearish on individual cryptocurrencies.
• Community Discussions: Each cryptocurrency has a dedicated discussion section.
• Favorites Management: Users can personalize their experience by tracking favorite cryptocurrencies.
• Administrator Panel: Admins can manage cryptocurrencies and moderate community activity.
• Gamification: A points system rewards user engagement and accurate predictions.

---

Objectives

Short-Term Goals (MVP)

• Deploy a functional Minimum Viable Product (MVP).
• Implement core features like sentiment voting, community discussions, and a real-time dashboard.

Long-Term Goals

• Enhance user engagement with gamification features.
• Expand functionalities with premium subscription plans offering advanced features like custom notifications.

---

Technologies Used

• Backend: Ruby 3.2.2, Rails 8
• Database: PostgreSQL 1.1
• Frontend: JavaScript, CSS
• Authentication: Devise
• Payments: Stripe
• Emailing: Mailjet
• Deployment: Heroku

---

Setup and Installation

Prerequisites

• Ruby 3.2.2
• Rails 8
• PostgreSQL

Installation Steps

1. Clone the repository:

   git clone <repository-url>
   cd Crypto-Voting-Project-main

2. Install dependencies:

   bundle install
   yarn install

3. Setup the database:

   rails db:create
   rails db:migrate
   rails db:seed

4. Start the server:

   rails server

5. Visit the application at http://localhost:3000.

---

Usage

• Navigate to the Live Application.
• Sign up or log in to access full features like voting and discussions.
• Admins can manage cryptocurrencies and moderate activity via the admin panel.

---

Contributors

• Florian Tribout
• Alexe Marichal
• Paul Moulin
• James Barthée
• Caroline Olivier

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Additional Links

• Trello Board for the Project
• Executive Summary Document
• Database Schema
• Figma Maquettes
• Wireframes on Miro