Giter Club home page Giter Club logo

footsteps-app's Introduction

👣 Footsteps - Learning Resources Aggregator

A Search 🔎Engine of Community-made 🧑‍🤝‍🧑learning resources for the 21st century learner.👨‍💻👩‍💻Learn by following the footsteps (resources) of experts or make your own, giving others the right advice/resources to learn.

GitHub issues GitHub forks GitHub stars

FOSSA Status LICENSE CODACY CODEFACTOR FOSSA Status

🤷 About

We envisioned the project to solve the problems faced by 21st-century learners. A modern learner finds a flood of resources from Google Search but doesn't always find the right resources since it's the website with the best SEO (search engine optimisation) that wins. There are so many free resources available on the internet made by experts in their field and yet we are forced to pay for the outdated courses promoted by big companies and universities.

With Footsteps app & browser extension, we take a mentor/subject knowledge expert first approach to solve the problem. The domain experts save their learning journey with our app and browser extension & make it available for everyone else to follow. Every resource is called a 'footstep' (added in a chronological manner) and a collection of footsteps makes up a learning path. The learner can "fork" the learning path made by the expert and keep a track of his progress. The app suggests resources & keeps an updated list with users upvotes & collaborative filtering.

🧐 The Need (as seen on the web)

Here are few examples of why we came up with footsteps:

Reddit thread - "About IBMs Data Science Certification"

🤩 Proposed/Upcoming features

SL No. Feature Status
01 Ability to make the path private/public.
02 The ability to "fork" a learning path & suggest changes.
03 A collaborative filtering recommendation system for recommending the right resources to a learner.
04 Ability to save your progress (with a progress bar) in a learning path.
05 Ability to upvote a learning path.
06 Ability to follow a user.
07 A modified home page UI with a search bar, active learning paths & new leaning paths by 'followed' users

🚀 Quick start

Here is our quickstart guide. See our Wiki for detailed instructions!

  1. Install the Gatsby CLI.

    npm install -g gatsby-cli
  2. Fork & Clone the repo

    git clone https://github.com/[yourname]/footsteps-app
  3. Install node dependencies

    Use the Gatsby CLI to create a new site, specifying the starter.

    cd footsteps-app/
    npm install
  4. Add Credentials to .env

    Create .env.development file and add your variables listed below.

    Use the below credentials for testing purposes

    GATSBY_HASURA_GRAPHQL_URL=http://rle-test.herokuapp.com/v1/graphql
    GATSBY_HASURA_GRAPHQL_ADMIN_SECRET=!footstepstest!
    GATSBY_FIREBASE_API_KEY=AIzaSyCfv2UcXCifCqmo6PhpdjKajVcpP_8Al9M
    GATSBY_FIREBASE_AUTH_DOMAIN=fnplus-rle-test.firebaseapp.com
    GATSBY_FIREBASE_DATABASE_URL=https://fnplus-rle-test.firebaseio.com
    GATSBY_FIREBASE_PROJECT_ID=fnplus-rle-test
    GATSBY_FIREBASE_STORAGE_BUCKET=fnplus-rle-test.appspot.com
    GATSBY_FIREBASE_MESSAGING_SENDER_ID=1042822146411
    GATSBY_FIREBASE_APP_ID=1:1042822146411:web:d09d2baa58dd82ff49842e
    GATSBY_GOOGLE_TRACKING_ID=UA-154496987-1

    For access to the Firebase project, please fill this form.

    For access to the testing DB, use this link & enter '!footstepstest!' as the password.

  5. Start developing. Navigate into your new site’s directory and start it up.

    gatsby develop
  6. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the footsteps-app directory in your code editor of choice and edit files under src. Save your changes and the browser will update in real time!

🎓 Learning Gatsby

Full documentation for Gatsby lives on the website.

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples head to our documentation. In particular, check out the “Guides”, “API Reference”, and “Advanced Tutorials” sections in the sidebar.

We welcome suggestions for improving our docs. See the “how to contribute” documentation for more details.

Start Learning Gatsby: Follow the Tutorial · Read the Docs

👨 Project Admin

  • Abhishek Uniyal

👬 Mentors

Name Point of Contact
Dev Daksan

Praveen Kumar

Sudipto Ghosh

Tarun Nagpal

Feel free to ask your queries!! 🙌

🏆 Competition

HakinCodes Logo

GSSoC Logo

📝 License

Licensed under the GPL v3 License.

❤️ Thanks

Thanks to our many contributors and to Netlify & Heroku for hosting footsteps.dev.

footsteps-app's People

Contributors

abhinashgiri avatar aditianshu avatar aman-codes avatar annu12340 avatar d3vd avatar dependabot[bot] avatar fossabot avatar harshmehta2468 avatar imabhishekkumar avatar imrishabh18 avatar krsnvijay avatar manxi avatar prajwal714 avatar praveenscience avatar pydevsg avatar ramneek008 avatar roshankcjha avatar saraikium avatar shreyakapoor08 avatar snyk-bot avatar suchana34 avatar xlogix avatar xtremilicious 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.