🎉 Welcome to the backend repository of PhriniFluent, an open-source language learning platform that's all about making language learning fun and accessible! This repository is the heart and soul of PhriniFluent, powering all the amazing features our users love.
This project spreads the love with the MIT License.
Our backend is crafted with care using Django and Django REST Framework (DRF), with Nginx as the trusty steed serving our web content.
PhriniFluentUser(inheritsAbstractUser)telegram_handle: CharField (max_length=100, unique, nullable, blank)
POST /signup: Begin your adventure by registering!POST /login: Welcome back! Time to dive in.
Language: 🌐 Languages that connect our world.WordGroup: 📝 Collections of words, shared or personal.WordGroupDescription: 📖 Stories behind each word group.Word: 🧩 Individual words that paint our thoughts.WordDescription: 🖋️ Meanings and nuances of each word.
GET /public_word_groups: Explore public word groups.GET /private_word_groups: Your personal linguistic treasure.GET /word_group/{group_id}/random_word: Discover a random word.POST /word/{word_id}/similarity: Compare and learn.
-
Docker Setup:
- 🏗️ Use
docker-compose up --buildto assemble and ignite the services.
- 🏗️ Use
-
Database Migration:
- 🛠️ After the grand launch, set up the database with:
docker-compose exec web python manage.py migrate - This magic spell runs the
migratecommand inside the 'web' service container.
- 🛠️ After the grand launch, set up the database with:
🤝 Your contributions bring PhriniFluent to life! Whether it's a bug fix, a feature, or just a bit of wisdom, we're all ears. Check out our issues page for current quests and adventures!
💫 Feel the joy of learning and sharing in the world of PhriniFluent! Together, we're making language learning not just effective, but magical! ✨