Skip to content

shubham0105jha/edu-web

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Educational Website

This is an educational website which shows the correct path to the computer science newbies to the learn their tech. The website has tabs like Videos, Books, Tutorials etc. Each tab has further sub-division covering all major CS domains - App Development, CS Core Subjects, Data Science, Programming and Web Development. A user can select any of these and will be navigated accordingly.

Benefits

The benefit of using our website is it accumulates all major resources of learning in a consise form. It means that many users know the resource which are quite high in number so they are confused as which is the for them. We provide the best 3 reosources related to any major cs domain which is atleast decreases the overload of the user of searching and selecting the resources.

Development

This website is backed by Node.js, i.e. the backend server-code. Currently it provides normal browsing of content along with the authencation feature. Authentication is of now is not of any use but since we are in development phase, we have planned to provide some really cool features which can be utilised only if the user is authenticated.

Runninng Server

To run the server first you must add 'nodemon.json' inside 'config' directory as shown in the Project Structure below and add the following code exactly same by assigning your 'secret access keys' in the values of the keys -

{
    "env" : {
        "MONGO_ATLAS_DB_PASSWD": <your_mondodb_atlas_database_password>,
        "JWT_KEY": <your_jwt_secret_key>
    }
}

Then install all the required packages as mentioned in 'package.json' file.

After all this, just type

npm run dev

in the terminal (Make sure there is internet connectivity otherwise this server can't connect to the mongodb atlas database).

Project Structure

edu-web
    |- config
    |   `- nodemon.json
    |- controllers
    |   `- user-controllers.js
    |- middleware
    |   `- auth.js
    |- models
    |   |- db
    |   |   `- mongodb-connector.js
    |   `- user-models.js
    |- node_modules
    |   :- ..
    |   :- ..
    |   `- ..
    |- public
    |   |- images
    |   |   :- ..
    |   |   :- ..
    |   |    `- ..
    |   |- javascript
    |   |   |- login.js
    |   |   |- logout.js
    |   |   |- profile.js
    |   |   |- side-nav.js
    |   |   `- signup.js
    |   `- stylesheets
    |       |- login.css
    |       |- signup.css
    |       `- style.css
    |- routes
    |   |- auth-api-routes.js
    |   `- static-page-routes.js
    |- views
    |   |- main-views
    |   |   :- ..
    |   |   :- ..
    |   |   `- ..
    |   `- partials
    |       :- ..
    |       :- ..
    |       `- ..
    |- .gitignore
    |- app.js
    |- package-lock.json
    |- package.json
    `- README.md

How to use

For example, a user wants to see videos of operating system. So he/she need to head over to 'Videos' tab and select 'CS Core Subjects', a new tab will open containing top 3 recommended videos of all CS core subjects. The user need to scroll down or directly jump with the help of side naviagtion bar to his/her desired subject, i.e, here its operating system.

Screenshots

Home page - ss1

ss2

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Handlebars 93.2%
  • JavaScript 4.1%
  • CSS 2.7%