-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 1d8c224
Showing
27 changed files
with
12,035 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @hoblin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: 'bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the Bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**Steps to Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected Behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional Context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
**Describe the changes** | ||
Clearly and concisely describe what you've changed and why. | ||
|
||
**Related Issue(s)** | ||
|
||
Fixes # | ||
|
||
**Checklist:** | ||
|
||
- [ ] I have added tests to cover my changes. | ||
- [ ] All new and existing tests passed locally. | ||
- [ ] Linter has passed locally. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
name: Continuous Integration | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
- develop | ||
|
||
jobs: | ||
test: | ||
name: Run RSpec | ||
runs-on: ubuntu-latest | ||
|
||
services: | ||
postgres: | ||
image: postgres:13 | ||
env: | ||
POSTGRES_USER: postgres | ||
POSTGRES_PASSWORD: postgres | ||
POSTGRES_DB: x_tracker_test | ||
ports: | ||
- 5432:5432 | ||
# needed because the postgres container does not provide a healthcheck | ||
options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5 | ||
|
||
steps: | ||
- name: Check out code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: 3.2 | ||
|
||
- name: Install dependencies | ||
run: | | ||
bundle config path vendor/bundle | ||
bundle install --jobs 4 --retry 3 | ||
- name: Create test credentials key file | ||
run: echo "${{ secrets.RAILS_TEST_MASTER_KEY }}" > config/credentials/test.key | ||
|
||
- name: Precompile assets | ||
run: bundle exec rails assets:precompile | ||
env: | ||
RAILS_ENV: test | ||
|
||
- name: Run tests | ||
run: bundle exec rspec | ||
- name: Display log | ||
if: failure() | ||
run: cat log/test.log | ||
|
||
lint: | ||
name: Run StandardRB | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check out code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: 3.2 | ||
|
||
- name: Install dependencies | ||
run: | | ||
bundle config path vendor/bundle | ||
bundle install --jobs 4 --retry 3 | ||
- name: Run linter | ||
run: bundle exec standardrb |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Yevhenii Hurin | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# X-Tracker | ||
|
||
X-Tracker is an open-source platform aimed at bringing transparency to social media interactions, particularly on Twitter. It allows users to monitor and track the statistics of specific tweets, providing a visual representation of how tweets are performing over time. | ||
|
||
## Features | ||
|
||
- Real-time tracking of tweet metrics including: | ||
- Likes | ||
- Views | ||
- Retweets | ||
- Retweets with citation | ||
- Comments | ||
- Bookmarks | ||
- User-friendly interface to add tweets to the tracking pool. | ||
- Advanced charting experience with Highcharts, allowing users to zoom, scroll, select different periods, and see real-time updates. | ||
- Tampermonkey script generation for users to run the tracker in their own browser and contribute to the data pool. | ||
- Community-driven: Users can contribute by adding new tweets to the pool or by running the tracking script to gather data. | ||
|
||
## Tech Stack | ||
|
||
- Ruby on Rails | ||
- Bulma for styling | ||
- Highcharts for data visualization | ||
- RSpec with FactoryBot for testing | ||
- PostgreSQL as the database | ||
- Hosted on Heroku | ||
|
||
## Setup and Installation | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone https://github.com/hoblin/x-tracker.git | ||
cd x-tracker | ||
``` | ||
2. Install dependencies: | ||
```bash | ||
bundle install | ||
yarn install | ||
``` | ||
3. Setup the database: | ||
```bash | ||
rails db:create db:migrate | ||
``` | ||
4. Start the Rails server: | ||
```bash | ||
rails s | ||
``` | ||
5. Open your browser and navigate to `http://localhost:3000`. | ||
|
||
## Contribution | ||
|
||
X-Tracker is an open-source project, and contributions are warmly welcomed. Whether you have suggestions, a bug report, or a feature request, feel free to open an issue or create a pull request. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |
28 changes: 28 additions & 0 deletions
28
assets/application-5232e6bde3032b129dcce7c5d4f140bb78bf1134d294a9f4a7842d993d0f7080.js
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.