Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/preetiraj3697/lingualingo

Interactive platform for language learning
https://github.com/preetiraj3697/lingualingo

clerkjs drizzle-orm nextjs14 postgresql react-admin reactjs stripe-checkout tailwindcss

Last synced: about 1 month ago
JSON representation

Interactive platform for language learning

Host: GitHub
URL: https://github.com/preetiraj3697/lingualingo
Owner: Preetiraj3697
Created: 2024-06-20T09:39:10.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-07-11T20:48:50.000Z (7 months ago)
Last Synced: 2024-11-12T01:43:51.408Z (3 months ago)
Topics: clerkjs, drizzle-orm, nextjs14, postgresql, react-admin, reactjs, stripe-checkout, tailwindcss
Language: TypeScript
Homepage: https://lingua-lingo.vercel.app
Size: 2.49 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # LinguaLingo - Interactive platform for language learning.

![LinguaLingo - Interactive platform for language learning.](Images/Postser.png "Lingo - Interactive platform for language learning.")

## :bangbang: Folder Structure

Here is the folder structure of this app.

```bash

LinguaLingo/

|-lingo

  |- actions/

    |- challenge-progress.ts

    |- user-progress.ts

    |- user-subscription.ts

  |- app/

    |-- (main)/

        |--- courses/

        |--- leaderboard/

        |--- learn/

        |--- quests/

        |--- shop/

        |--- layout.tsx

    |-- (marketing)/

        |--- footer.tsx

        |--- header.tsx

        |--- layout.tsx

        |--- page.tsx

    |-- admin/

        |--- challenge/

        |--- challengeOption/

        |--- course/

        |--- lesson/

        |--- unit/

        |--- app.tsx

        |--- page.tsx

    |-- api/

        |--- challengeOptions/

        |--- challenges/

        |--- courses/

        |--- lessons/

        |--- units/

        |--- webhooks/stripe/

    |-- lesson/

        |--- [lessonId]/

        |--- card.tsx

        |--- challenge.tsx

        |--- footer.tsx

        |--- header.tsx

        |--- layout.tsx

        |--- page.tsx

        |--- question-bubble.tsx

        |--- quiz.tsx

        |--- result-card.tsx

    |-- favicon.ico

    |-- globals.css

    |-- layout.tsx

  |- components/

    |-- modals/

    |-- ui/

    |-- feed-wrapper.tsx

    |-- mobile-wrapper.tsx

    |-- mobile-sidebar.tsx

    |-- promo.tsx

    |-- quests.tsx

    |-- sidebar-item.tsx

    |-- sidebar.tsx

    |-- sticky-wrapper.tsx

    |-- user-progress.tsx

  |- config/

    |-- index.ts

  |- db/

    |-- drizzle.ts

    |-- queries.ts

    |-- schema.ts

  |- lib/

    |-- admin.ts

    |-- stripe.ts

    |-- utils.ts

  |- public/

  |- scripts/

    |-- prod.ts

    |-- reset.ts

    |-- seed.ts

  |- store/

    |-- use-exit-modal.ts

    |-- use-hearts-modal.ts

    |-- use-practice-modal.ts

  |- types/

    |-- canvas.ts

  |- .env

  |- .env.example

  |- .eslintrc.js

  |- .gitignore

  |- .prettierrc.json

  |- components.json

  |- constants.ts

  |- drizzle.config.ts

  |- environment.d.ts

  |- middleware.ts

  |- next.config.mjs

  |- package-lock.json

  |- package.json

  |- postcss.config.js

  |- tailwind.config.ts

  |- tsconfig.json

```




## :toolbox: Getting Started

1. Make sure **Git** and **NodeJS** is installed.

2. Clone this repository to your local computer.

3. Create `.env` file in **root** directory.

4. Contents of `.env`:

```env

# .env

# disabled next.js telemetry

NEXT_TELEMETRY_DISABLED=1

# clerk auth keys

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

CLERK_SECRET_KEY=sk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

# neon db uri

DATABASE_URL="postgresql://:@:/lingo?sslmode=require"

# stripe api key and webhook

# public app url

NEXT_PUBLIC_APP_URL=http://localhost:3000

# clerk admin user id(s) separated by comma and space (, )

CLERK_ADMIN_IDS="user_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx, user_xxxxxxxxxxxxxxxxxxxxxx"

```

5. Obtain Clerk Authentication Keys

   1. **Source**: Clerk Dashboard or Settings Page

   2. **Procedure**:

      - Log in to your Clerk account.

      - Navigate to the dashboard or settings page.

      - Look for the section related to authentication keys.

      - Copy the `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY` provided in that section.

6. Retrieve Neon Database URI

   1. **Source**: Database Provider (e.g., Neon, PostgreSQL)

   2. **Procedure**:

      - Access your database provider's platform or configuration.

      - Locate the database connection details.

      - Replace ``, ``, ``, and `` placeholders in the URI with your actual database credentials.

      - Ensure to include `?sslmode=require` at the end of the URI for SSL mode requirement.

7. Fetch Stripe API Key and Webhook Secret

   1. **Source**: Stripe Dashboard

   2. **Procedure**:

      - Log in to your Stripe account.

      - Navigate to the dashboard or API settings.

      - Find the section related to API keys and webhook secrets.

      - Copy the `STRIPE_API_SECRET_KEY` and `STRIPE_WEBHOOK_SECRET`.

8. Specify Public App URL

   1. **Procedure**:

      - Replace `http://localhost:3000` with the URL of your deployed application.

9. Identify Clerk Admin User IDs

   1. **Source**: Clerk Dashboard or Settings Page

   2. **Procedure**:

      - Log in to your Clerk account.

      - Navigate to the dashboard or settings page.

      - Find the section related to admin user IDs.

      - Copy the user IDs provided, ensuring they are separated by commas and spaces.

10. Save and Secure:

    - Save the changes to the `.env` file.

11. Install Project Dependencies using `npm install --legacy-peer-deps` or `yarn install --legacy-peer-deps`.

12. Run the Seed Script:

In the same terminal, run the following command to execute the seed script:

```bash

npm run db:prod

```

This command uses `npm` to execute the Typescript file (`scripts/prod.ts`) and writes challenges data in database.

13. Verify Data in Database:

Once the script completes, check your database to ensure that the challenges data has been successfully seeded.

14. Now app is fully configured 👍 and you can start using this app using either one of `npm run dev` or `yarn dev`.

**NOTE:** Please make sure to keep your API keys and configuration values secure and do not expose them publicly.

## :camera: Screenshots

![Modern UI/UX](/Images/Screenshot%20(67).png "Modern UI/UX")

![Quests](/Images/Screenshot%20(79).png "Quests")

![Shop](/Images/Screenshot%20(80).png "Shop")

![lesson](/Images/Screenshot%20(77).png "lesson")

## :gear: Tech Stack

[![React JS](https://skillicons.dev/icons?i=react "React JS")](https://react.dev/ "React JS") [![Next JS](https://skillicons.dev/icons?i=next "Next JS")](https://nextjs.org/ "Next JS") [![Typescript](https://skillicons.dev/icons?i=ts "Typescript")](https://www.typescriptlang.org/ "Typescript") [![Tailwind CSS](https://skillicons.dev/icons?i=tailwind "Tailwind CSS")](https://tailwindcss.com/ "Tailwind CSS") [![Vercel](https://skillicons.dev/icons?i=vercel "Vercel")](https://vercel.app/ "Vercel") [![Postgresql](https://skillicons.dev/icons?i=postgres "Postgresql")](https://www.postgresql.org/ "Postgresql")

## :gem: Acknowledgements

Useful resources and dependencies that are used in Lingo.

- Thanks to CodeWithAntonio: https://codewithantonio.com/

- Special Thanks to Kenney Assets: https://kenney.nl/

- Freesound: https://freesound.org/

- Elevenlabs AI: https://elevenlabs.io/

- Flagpack: https://flagpack.xyz/

## 🌐 Connect with me:





  





   





  





  



 

  



  

  






  




 

 © 2022 | Preeti Raj