collinsugwu/Waitlistr

[][license-url]

Waitlistr

Waitlistr ROR skill test
Explore the docs �

� Report Bug � Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Create a Rails application that will pull data from a stock market API (e.g. https://marketstack.com/) from some symbols that must be saved as records. These symbols are part of your wallet and users must be able to create, edit and list all these symbols in the app. Also, we must be able to create alerts for each symbol, that will create records for each event that matches the thresholds (price < X or price > Y). These alert records must be displayed in the app somewhere.

Built With

This progam was made using this technologies

• Ruby 3
• Rails 7
• PostgreSQL
• Rubocop
• RSpec

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Ruby You can easily install Ruby on your Linux computer by using Homebrew and Chruby

brew install chruby
brew install ruby-install
ruby-install ruby

• Rails You can easily install Rails directly from the rails site

  gem install rails

Installation

1. Clone the repo

git clone https://github.com/collinsugwu/Waitlistr

3. Install Dependencies in your rails app

bundle install

4. Migration

rails db:migrate

4. Seed database with fakedata

rails db:seed

4. Testing

rspec

5. Start Server

rails s

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• Collins Ugwu: Github, Twitter

Project Link: https://github.com/collinsugwu/Waitlistr