https://github.com/alxv07/icescreamerst
I.ntelligent C.omputer E.ngineers S.ometimes C.reate R.idiculously E.nigmatic A.ggravating M.onstrosities E.xpressed R.adically as S.horthands so we made a t.ool to help w/ that :D
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Repository
I.ntelligent C.omputer E.ngineers S.ometimes C.reate R.idiculously E.nigmatic A.ggravating M.onstrosities E.xpressed R.adically as S.horthands so we made a t.ool to help w/ that :D
Basic Info
- Host: GitHub
- Owner: AlxV07
- Language: JavaScript
- Default Branch: main
- Size: 61.4 MB
Statistics
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
I.C.E.C.R.E.A.M.E.R.S.t.
I.ntelligent
C.omputer
E.ngineers
S.ometimes
C.reate
R.idiculously
E.nigmatic
A.ggravating
M.onstrosities
E.xpressed
R.adically
as
S.horthands
so we made a
t.ool
to help with that :D
This idiotic team name drives home the point that newcomers (e.g. new employees, interns, non-tech people) are sometimes met with complex and confusing abbreviations, acronyms, or terms which seem to be from a different language.
ICESCREAMERSt (pronounced ice-screamers-tee) provides a simple solution: a convenient interface where users can quickly search find out what unfamiliar terms mean.
How Hackday Went
First time pretty much for all of us working in a team env for a hackathon so the codebase is not the prettiest (apologies, code reviewers), but we finished w/ an actually presentable project I think :D (Writing this at 2a.m. as we're finishing editing the presentation vid)
App is started w/ python3 app.py & going to the port the application is serving in browser (after installing required packages in requirements.txt);
a .env file in the root-project directory w/ a GROQ_API_KEY var needs to be set to support AI-search.
The chrome_extension folder can be loaded as an unpacked Chrome extension (enable dev mode in chrome://extensions)
and will appear in the extension toolbar; requires app.py to be running right now to work though.
Though of course there still remain technical hurdles to overcome to become a publicly-usable application (a secure submit system (perhaps linked to a State Farm account), complete AWS database integration, etc.), our application lays out a solution and illustrates a functional example of how such an application can serve a real need in corporate.
Setup for Devs
- Clone project
- In project directory:
pip install -r requirements.txt - And then configure AWS (install aws-cli if needed):
aws configure(will prompt for your credentials, talk to Alex if this setup needed) - Open project directory in editor, and you're good to go!
Project Overview
Tech Stack
- Vanilla HTML-JS-CSS frontend
- Served locally over Python Flask server
- AWS DynamoDB database
- Data:
- Terms
- Context/tags/documentation/resources for terms
- Query Operations:
- Read terms from database
- Write new term to database
- Change term information
Flow
``` | User Interface | ^ | Search & sort queries | v | Flask Server | ^ | Query Operations | v | AWS Database (as of Hackday, we're using a local CSV file as a mock database for simpler testing, but AWS support can always be implemented later) |
```
Extensions & Scalability
TODO: talk abt potential developments and expansions to the app
Owner
- Name: Alexander Chen
- Login: AlxV07
- Kind: user
- Location: Texas, US
- Repositories: 1
- Profile: https://github.com/AlxV07
9th Grade - Homeschool + Online School, Programming for ~3 years - Arch Linux - USACO Silver - Enjoys Lisp, Python, & Java
GitHub Events
Total
- Watch event: 2
- Delete event: 1
- Member event: 2
- Public event: 1
- Push event: 30
- Pull request event: 2
- Fork event: 1
- Create event: 1
Last Year
- Watch event: 2
- Delete event: 1
- Member event: 2
- Public event: 1
- Push event: 30
- Pull request event: 2
- Fork event: 1
- Create event: 1
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| AlxV07 | a****n@g****m | 41 |
| skandacode | 3****e | 36 |
| Faizan Masroor | f****1@g****m | 12 |
| Callie08 | c****i@g****m | 4 |
| = | = | 4 |
| amnaashraf0 | a****0@g****m | 2 |
| Trisha Gorusu | t****u@T****l | 2 |
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- skandacode (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- flask *