/communitytaught

Primary LanguageCSSMIT LicenseMIT

CommunityTaught.org

A comprehensive tracker for 100Devs classes and homework.

CONTRIBUTING

If you'd like to work on this project, please see the contributing guidelines in CONTRIBUTING.md.

I built the website without really taking collaboration into account and the project needs some work in terms of both documentation and processes. I am in the process of getting that built out, but in the meantime, here are the basic steps to get the project up and running locally:

  • fork the repository
  • create a MongoDB database locally or on Atlas
  • import the class and homework data into your database (see the /data folder)
  • rename example.env to .env and add your credentials (.gitignore will ignore the .env so your credentials won't get pushed to Github)
  • Set up mailhog if you are using email and password login

Live website: CommunityTaught.org

Preview of CommunityTaught.org

How It's Made

Tech used: Node.js, Express, MongoDB, Pug, Tailwind CSS

This app was built from scratch using my authentication boilerplate as the base for the code, and my previous homework tracker as the base for the application design.

Optimizations and Improvements

  • Tests & refactoring to make unit tests easier.
  • Possibly switching the front end to React + Typescript.
  • Progress bars to show how much of the course has been completed.
  • API integrations to automatically check if certain tasks (like Twitter check-in) have been completed.
  • Video timestamps.
  • Note-taking alongside the videos.

Lessons Learned:

  • This is the largest project I've built so far, and certain parts of it were new to me. First, second, and even third attempts sometimes felt wrong - too complex, difficult to read, or slow to execute. I learned that this gut feeling is usually right, but it's also ok to move on temporarily rather than dwelling on a single problem.