Fluent

Language learning platform with gamification and immersive lessons
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgments

About The Project

Fluent is a Duolingo-style language learning platform that offers guided lessons with immersive characters, audio-visual effects, and interactive exercises. Users can track progress and stay motivated through hearts, XP, quests, leaderboards, and a shop system. The platform also includes a Pro subscription for unlimited hearts and features practice modes to regain lost hearts, making learning engaging and fun.

(back to top)

Built With

These are the main frameworks and libraries used to build Fluent. Additional tools and assets are listed in the Acknowledgements section.

(back to top)

Getting Started

Follow these steps to get a local copy of Fluent up and running on your machine.

Prerequisites

You’ll need the following installed:

• Node.js (v20+)
• npm (v10+)

  npm install npm@latest -g
  

• A Clerk account for authentication
• A Stripe account if you want to test the Pro subscription

Installation

1. Clone the repo

   git clone https://github.com/vxnsh1/fluent.git
   cd fluent
   

2. Install dependencies

   npm install
   

3. Set up environment variables Create a .env.local file in the root directory and add:

   NEXT_PUBLIC_CLERK_FRONTEND_API=your_clerk_frontend_api
   CLERK_API_KEY=your_clerk_api_key
   NEON_DATABASE_URL=your_neon_database_url
   STRIPE_SECRET_KEY=your_stripe_secret_key

4. Run the development server

   npm run dev
   

   Open http://localhost:3000 to view the app in your browser.

(back to top)

Contributing

Contributions help make Fluent better for everyone! Whether it’s fixing bugs, adding new lessons, or improving the UI/UX, your contributions are greatly appreciated.

If you have ideas or suggestions:

1. Fork the repository
2. Open an issue with the tag "enhancement" or "bug"

How to Contribute

1. Fork the project

2. Create your feature branch

   git checkout -b feature/AmazingFeature
   

3. Commit your changes

   git commit -m "Add some AmazingFeature"
   

4. Push to your branch

   git push origin feature/AmazingFeature
   

5. Open a Pull Request and describe your changes.
   
   

Don’t forget to give the project a ⭐ if you like it!

⚠️ Note: Stripe payments aren’t currently working for Indian users due to local restrictions.

(back to top)

Contact

Vansh Chouhan - @vanshchouhan

(back to top)

Acknowledgments

• Neon DB
• Eleven Labs
• Vercel
• Lucide Icons

(back to top)