ej8899 / lhlfinals

LearnThis! A learning resource collection system for developers! Bring together all your resources and bookmarks in an easy to find, sort and search system!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LearnThis!

A bookmarking, organizational and learning tool built for the developer community.

Keep your resource bookmarks all in one convenient location while having a quick organizational system and a built in learning program to actually study from your saved materials!

Screen Shot of app


Contents...

  1. Getting Started
  2. Features
  3. Future Plans
  4. Known Bugs
  5. Attributions
  6. Updates
  7. The Team

Getting Started

Clone the repository to your computer. You'll also need the server and SQL data that is available within this same github repository.

SERVER Getting Started

  1. Create the .env by using .env.example as a reference: cp .env.example .env
  2. Update the .env file with your correct local information
  • username: development
  • password: development
  • database: finals
  1. Install dependencies: npm i
  2. Create database finals using
  • psql -U development
  • create databaase finals;
  1. Reset database: npm run db:reset
  • Check the db folder to see what gets created and seeded in the SDB
  1. Create account in screenshotapi.net and get the API KEY
  2. Add TOKEN=API KEY in .env. See .env.example
  3. Run the server without nodemon: npm start
  4. Run the server with nodemon: npm run local
  • Note: nodemon is used, so you should not have to restart your server
  1. Visit http://localhost:8080/
  2. login: 12345@test.com password: 1234
    ( back to top ๐Ÿ”บ)

Features...

  • Learning Component:

    • We've included a built in lesson planning system in LearnThis! that intelligently develops a suggested learning process based on the lesson topic(s) you are interested in. Using an algorithm to determine ideal placements, you can start at the first displayed resource and work your way to the final resource in order of complexity and suggested order. Screen Shot of lesson planner component
  • API and Data Structure

    • All api and data structure
  • replace this as necessary Screen Shot of main feature component

( back to top ๐Ÿ”บ)

Bonus features...

  • LearnThis! also includes a helpful resource clipping browser extension tool. One click grabs the title and description of the page you're on and lets you save it quickly into the LearnThis! database! Screen Shot of Resource Clipper
    ( back to top ๐Ÿ”บ)

Future Plans...

  • streamlining React state
  • twitter DM to app bookmarks
  • improve resource 'note-taking' systems to allow for code blocks
  • add user general comments (public)
  • making database more efficient
    ( back to top ๐Ÿ”บ)

Known Bugs...


Attributions...


Updates...


The Team...

  • Atsuyuki Yoshimatsu
    (back end API developer)
  • Gene Tenorlas
    (back end API, database schema developer)
  • Ernie Johnson
    (front end, back end interface developer)
    .
    ( back to top ๐Ÿ”บ)

About

LearnThis! A learning resource collection system for developers! Bring together all your resources and bookmarks in an easy to find, sort and search system!


Languages

Language:JavaScript 95.5%Language:CSS 1.6%Language:SCSS 1.5%Language:HTML 1.4%Language:Shell 0.0%