Git Product home page Git Product logo

learning-platform's Introduction

Adis Learning Platform

Overview

An online learning platform.

Link to site: https://adis-learning-platform.herokuapp.com/

This site was created using:
- NextJS for frontend framework
- Styled Components as CSS-in-JS tool
- Express for server
- JSON mock data for building REST APIs

Hosted on Heroku.
Static assets author: [Anna Yashina](https://dribbble.com/chebarsu)

Run project locally:

Clone the repo to your local machine.

git clone 
cd learning-platform

Install all dependencies:

npm install

Start the server:

node server/index.js
open http://localhost:3000

Notes/Limitations

Project still in progress

  • implement "likes" and "notifications" feature
  • add components to course detail pages
  • fix navbar drop down css

Data fetching strategy: I "fetched" data from the API from the client side instead of server side because something like a dashboard contains data assigned to each unique user, and it's not usually pre-rendered due to its dynamic nature. This strategy first renders the page, and then displays data once fetched, using "SWR" - a React Hook that NextJS recommends.

Front-End CSS: It was not ideal to build only with React Styled Components, particularly for responsiveness. It would be handy to include other frameworks like Tailwind or Bulma to help with CSS grids or flexboxes.

Directory Structure: I stuck to the MVC pattern as much as possible to keep information separated from each other (e.g. server, styles and components are in different directories).

Following NextJS's project structure, I added on a few things:

  • Components directory: Re-usable components that appear on all pages (e.g. Footer)
  • Styles directory: Mirrors the "Components" and "pages" directory, but for styles
  • Server directory: I added the custom express server within the client folder, along with mock data. That way, it's easy to develop while running only one server rather than two.

Routes

Route Path
Home GET /
Favourites GET /favourites
Notifications GET /notifications
Progress GET /progress/course/[course.id]-[course.title]
Recommended GET "/recommended/course/[course.id]-[course.title]
Trending GET "/trending/course/[course.id]-[course.title]
Categories GET "/category/[category.title]

Dependencies

  • NextJS
  • React Styled Components
  • Material UI Icons
  • ExpressJS
  • SWR

learning-platform's People

Contributors

aadhi-n avatar

Watchers

 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.