https://github.com/luhluh-17/stock-trading

A Ruby on Rails 7 application that simulates purchasing and selling stocks
https://github.com/luhluh-17/stock-trading

rails-application rails7 ruby

Last synced: 7 months ago
JSON representation

A Ruby on Rails 7 application that simulates purchasing and selling stocks

• Host: GitHub
• URL: https://github.com/luhluh-17/stock-trading
• Owner: luhluh-17
• Created: 2022-09-30T23:28:08.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-01T17:53:45.000Z (over 3 years ago)
• Last Synced: 2025-04-03T20:18:30.371Z (over 1 year ago)
• Topics: rails-application, rails7, ruby
• Language: Ruby
• Homepage: https://rails-stock-trading.fly.dev/
• Size: 339 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Stokd

A Ruby on Rails 7 application that simulates purchasing and selling stocks

### ⚙ Setup 

To run the project locally

1. Clone the repository

2. Create an environment file ".env" in the root folder

3. Set values to the following variables. example syntax: "USERNAME = 'User1'"

    1. USER_NAME (Email address of the account use to send confirmation emails to newly created accounts)

    2. PASSWORD (Password of the account use to send confirmation emails to newly created accounts)

    3. SECRET (Secret key obtain from IEX API)

    4. PUBLISHABLE (Publishable key obtain from IEX API)

    5. ENDPOINT (IEX API Link - https://cloud.iexapis.com/v1)

4. Navigate to folder

4. Create Postgresql database using command "rails db:create"

5. Run migrations using command "rails db:migrate"

6. [OPTIONAL] Populate database using command "rails db:seed"

7. Run Rails Server using "rails s"

### 💻 Features:

#### General

* Register and Login account using Devise gem

* Send email confirmation on upon registration

#### Admin

* Approve and Reject users account

* Edit users information

* Display all transactions made by users 

#### User

* View list of trending stocks

* Search stock using IEX API

* Buy and Sell stocks in Marketplace

* Update Buyer and Seller balance after each transaction

* Display transactions made by the user

### 🚀 Live Demo

https://rails-stock-trading.fly.dev/

#### Dummy Accounts

Accounts    | Email & Password

:---------: | :-------------------------------:

Admin       | `admin@test.com` / password

User1       | `user1@test.com` / password

User2       | `user2@test.com` / password

### 👨🏽‍💻 Tech Stacks

Category    | Languages / Frameworks / Tools

:---------: | :-------------------------------:

Front-end   | [![html5](https://upload.wikimedia.org/wikipedia/commons/thumb/3/38/HTML5_Badge.svg/64px-HTML5_Badge.svg.png)][1] [![css3](https://upload.wikimedia.org/wikipedia/commons/thumb/6/62/CSS3_logo.svg/64px-CSS3_logo.svg.png)][2] 

Back-end    | [![ruby](https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Ruby_logo.svg/64px-Ruby_logo.svg.png)][3] [![ruby on rails](https://upload.wikimedia.org/wikipedia/commons/thumb/6/62/Ruby_On_Rails_Logo.svg/170px-Ruby_On_Rails_Logo.svg.png)][4] [![PostgreSQL](https://upload.wikimedia.org/wikipedia/commons/thumb/2/29/Postgresql_elephant.svg/64px-Postgresql_elephant.svg.png)][5]

### 🛠 Database

#### View the [Entity Relationship Diagram](https://github.com/luhluh-17/stock-trading/blob/main/docs/erd-1.png)

### 📷 Screenshots

![user-dashboard-min](https://user-images.githubusercontent.com/33846123/196827387-77fafd53-e36b-4bbd-9f1e-8dc68ad7ee16.png)

![admin-transactions-min](https://user-images.githubusercontent.com/33846123/196827414-8e1ad1d7-bb65-47c0-bf89-646eff2bc932.png)

### 👥 Team/Contributors



  





  



[1]: https://developer.mozilla.org/en-US/docs/Glossary/HTML5

[2]: https://developer.mozilla.org/en-US/docs/Web/CSS

[3]: https://www.ruby-lang.org/en/

[4]: https://rubyonrails.org/

[5]: https://www.postgresql.org/