https://github.com/nickersoft/tldr
A search engine for class notes. 100% free.
https://github.com/nickersoft/tldr
Last synced: 15 days ago
JSON representation
A search engine for class notes. 100% free.
- Host: GitHub
- URL: https://github.com/nickersoft/tldr
- Owner: Nickersoft
- Created: 2016-01-28T04:00:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:46:09.000Z (over 2 years ago)
- Last Synced: 2025-01-12T02:11:18.772Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.93 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
A Search Engine For Students
----------------------------
TLDR is an Internet acronym for "too long, didn't read". It is this acronym that powers the TLDR (stylized tl;dr) search engine, which allows students to upload and search an endless stream of course notes, reading notes, practice exams, and more for no charge. Think of it as an entire world of summarized information. Sound cool? Keep reading, my friend.
### Running TLDR
Getting up and running with TLDR is ridiculously simple. Just `cd` into the source directory and run:
make
One word. See? Simple. Of course, if you want to do a little more than just run everything at once, here's a nice table of what you can do with the `make` command:
| Command | Description |
|---------------------|-----------------------------------------------------------|
| `make assets` | Builds *all* CSS and JavaScript |
| `make clean` | Removes the database file, as well as all compiled JS/CSS |
| `make css` | Compiles (custom) SASS |
| `make dependencies` | Installs all Node and Laravel dependencies |
| `make js` | Compiles Javascript using r.js |
| `make serve` | Runs the Laravel server at localhost:8000 |
| `make semantic` | Rebuild Semantic UI |
| `make static` | Builds (custom) CSS and JS |
And, of course, to visit TLDR just visit:
http://localhost:8000
in your browser.