Coder Social home page Coder Social logo

didact-fe's Introduction

Didact

You can find the deployed project at https://didactlms.com.

Contributors

Andrew Allen Jonathan Scott Eli Sacks Seth Nadu Ben Allen Mark Dudlik Todd McKenzie


MIT React Redux Styled-Components MaterialUI Netlify Status

Project Overview

Trello Board

Product Canvas

UX Design files

Didact is a hub that supports self-directed online learners through teaching and learning together

Didact believes everyone is a teacher, and the strongest way to learn is as part of a community that teaches and learns together.

Didact aims to bring together online learning resources in a way that encourages thoughtful time management and goal setting with integrated support strategies so students can reach their self-educational goals, no matter the source of their lessons.

Key Features

  • Adding online courses manually or via Udemy url
  • Adding learning paths
  • Adding courses and single goal todos to a learning path
  • Tracking user progress on paths and courses
  • search functionality for courses/paths

Tech Stack

Front end built using:

  • Popular framework with a big support ecosystem
  • Fast and scalable
  • Focus on dry code
  • Centralized state management via a single store
  • Scales very well in large projects
  • Solid CSS library with nice animation features built in
  • The ability create easily reusable code in the form of React components that reduces CSS code duplication
  • Cleaner to write REST calls than using 'Fetch'
  • Tracking data in a concise and easy way
  • Free alternative to auth0
  • Handles social logins in a relatively simple way
  • Simplifies dragging and dropping HTML elements
  • Handles form security in a clean way
  • Form validation made easy
  • Native integration with Formik

Front end deployed to https://didact-fe.netlify.com/

Back end built using:

  • quick spin up
  • familiarity
  • good documentation
  • We knew how to use it
  • It's lightweight
  • Works with nodejs
  • Many useful packages
  • Free alternative to auth0
  • Handles social logins in a relatively simple way
  • Simplifies SQL queries
  • Allows for third party email service
  • Simplifies ajax/REST calls
  • Hashes passwords
  • Allows us to make ajax calls to
  • To process .env variables
  • secures your express app with HTTP headers
  • Generates a 64 bit token containing user credentials
  • SQL dataBase solution for deployment
  • SQL dataBase solution for development

APIs

Passport.js (google/facebook APIs)

Passport.js interfaces with google and facebook auth apis to allow users to sign in via existing social accounts

Udemy API

https://www.udemy.com/developers/affiliate/models/user/

"The Udemy Affiliate API exposes a lot of functionalities of Udemy to help developers build client applications and integrations with Udemy.

It is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. We only accept https calls to the API. All responses will be returned in JSON format, including errors. OAuth 2 protocol is used for user authorization (not documented yet).

Udemy Affiliate API is currently at version 2.0 and the root endpoint is https://www.udemy.com/api-2.0/ for all resources."

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  REACT_APP_MIXPANEL - Mixpanel token used for tracking user actions

Content Licenses

Image Filename Source / Creator License
ITC Grouch Font Tom Carnase, Ronne Bonder EULA

|

Testing

Cypress.io was used for testing

  • It has nice end-to-end functionality with good documentation and built in examples

Installation Instructions

* yarn install

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

didact-fe's People

Contributors

sethnadu avatar jondscott21 avatar andrewa0112 avatar bastlifa avatar allenben746 avatar toddmckenzie avatar lambda-integrations avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.