ADD Learn

---

Add Learn is an online e-learning platform designed to deliver real-world skills without interruptions.

📝 Table of Contents

• 📝 Table of Contents
• 🧐 About
• 🏁 Getting Started
  • Prerequisites
  • Installing
• 🎈 Usage
• 🚀 Deployment
• ⛏️ Built Using
• ✍️ Authors

🧐 About

Add Learn is an online e-learning platform aiming to provide real world skills to the youth without any distractions.

This repository hosts only the frontend of the Add Learn. The backend of Add Learn is found on this repository.

Backend Repository Here

🏁 Getting Started

These instructions will get you the frontend of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project into the production.

Prerequisites

Make sure that you have these installed on your local machine before the installation of this project.

NodeJS 20.11.1 or above
Git CLI

Installing

Here you can follow these steps to setup the frontend of Add Learn on your local machine. A step by step series of examples that tell you how to get a development env running.

First clone this repo on your local machine using this command and open this project in a code editor, say VS Code.

git clone https://github.com/DevanshSK/add-learn

Then create a .env.local file and set the following environment variables.

• NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME contains the cloud name of cloudinary api.
• My_EMAIL and EMAIL contains the email address of that email which is used to send emails to the users.
• PASS variable contains the App Password of the given email address.

NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=
MY_EMAIL=
EMAIL=
PASS=

Then install all the modules by using this command.

npm install

And run the frontend by using this command.

npm run dev

🎈 Usage

After these steps, the frontend will start running locally on the url https://localhost:3000

The live deployment of this web app can be found at https://add-learn.vercel.app

🚀 Deployment

You can deploy this appication on the vercel just as we deploy a NextJS project.

Make sure that the following enviroment variables has been added to the vercel configuration.

Check out Next.js deployment documentation for more details.

⛏️ Built Using

• React/NextJS - Frontend Framework
• TailwindCSS - For Styling
• ShadCN UI - For UI Components
• Typescript - Programming Language
• Redux-Toolkit - For State Management
• RTK-Query - For Data Fetching.

✍️ Authors

• @devanshsk - Frontend Developer
  • Developed the responsive user-interface and dashboards using Tailwind and ShadCN-UI.
  • Implemented FastAPI Restful Api's with efficient data fetching and state management using Redux-Toolkit and RTK-Query.
  • Built a robust role based authentication with Redux and JWT Tokens.
  • Deployed the application on Vercel.
• @abhayg951 - Backend Developer
  • Created Restful Api's with FastAPI framework utilizing Python and PostgresSQL database.
  • Built a robust role based jwt authentication for users and admin.
  • Added authorised form submissions using Authorization token and FormData.
  • Developed various Api's for users, courses and chapters. Including video and file handling using cloudinary.
  • Created a GUI for accessing the API's using Swagger UI.
• @DevanshDixitDD - UI/UX Designer and Frontend Developer
  • Designed the brand identity and user interface of the ADD Learn.
  • Designed and developed mordern and responsive landing pages with asthetically pleasing animations.
  • Implemented NextJS with Server components to make the landing pages performance faster.

See also the list of contributors who participated in this project.