Aklish is a web app that crowdsources Aklanon-English translations. The platform lets users contribute translations with quality control (dictionaries and spellcheckers) and engagement (leaderboards and word games) strategies.
- Bidirectional input of translations
- Browse and search
- Voting system
- Aklanon-English dictionary
- Aklanon and English proofreader (spellchecker)
- Points (reputation) system
- Leaderboard system
- Games
- Wordle
- Synonym-antonym match
- Authentication
- Front-End: JS ES14, React 18, HTML 5, CSS 4, SASS 1, Bootstrap 5
- Back-End: Python 3, Django 5
- Database: MySQL
- APIs: REST
- Testing: PyTest
- Deployment: Railway
- Register an account: since some features can only be accessed by authenticated users, sign up to create a new account or sign in if you already have one.
- Earn reputation: some features can only be accessed by earning enough reputation points.
- Participate: to earn reputation, submit translations, bookmark, vote, and more.
- Learn more: visit the help center for more information.
- Clone the repo
git clone https://github.com/andrianllmm/aklish.git cd aklish - Create and activate a virtual environment
python -m venv env source venv/bin/activate # or `venv\Scripts\activate` for Windows
- Install the dependencies
pip install -r requirements.txt
- Apply migrations
python manage.py migrate
- Run the development server
python manage.py runserver
Create a .env file and configure the following variables:
DATABASE_URL: database connection URLSECRET_KEY: Django secret keyDEBUG: set toTruefor development orFalsefor production
Contributions are welcome! To get started:
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
Found a bug or issue? Report it on the issues page.