Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andrianllmm/aklish

A Django x React.js web application for crowdsourcing Aklanon-English translations.
https://github.com/andrianllmm/aklish

dictionary django react spellcheck translation word-games

Last synced: 11 days ago
JSON representation

A Django x React.js web application for crowdsourcing Aklanon-English translations.

Host: GitHub
URL: https://github.com/andrianllmm/aklish
Owner: andrianllmm
License: gpl-3.0
Created: 2024-03-18T10:59:03.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-08-19T14:43:21.000Z (3 months ago)
Last Synced: 2024-08-19T17:34:08.459Z (3 months ago)
Topics: dictionary, django, react, spellcheck, translation, word-games
Language: CSS
Homepage: https://aklish.up.railway.app
Size: 47.5 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Aklish

**A Django x React.js web application for crowdsourcing Aklanon-English translations.**

↗ Site

## About

[Aklish](https://aklish.up.railway.app) is a web application designed to facilitate the crowdsourcing of Aklanon-English translations. It offers a collaborative platform where users can contribute and manage translations between Aklanon and English. The app focuses on community engagement and high-quality results by employing several key strategies.

Key [features](#features) of Aklish include a community voting system for evaluation, an Aklanon-English dictionary for reference, proofreaders to ensure entry quality, and a points system similar to [StackOverflow’s](https://stackoverflow.com/help/whats-reputation) to enhance accountability. To boost user participation, Aklish includes leaderboards and interactive games, such as a [Wordle](https://www.nytimes.com/games/wordle/index.html) clone and synonym-antonym matching.

By supporting the Aklanon language’s preservation and enrichment, Aklish provides valuable resources for both linguistic enthusiasts and everyday users.

## Features

1. Bidirectional Input of Entries
2. Multiple Translations for a Single Entry
3. Browse Entries
4. Search Entries
5. Authentication
6. Quality Control Strategies
- Voting System
- Aklanon-English Dictionary
- Aklanon and English Proofreader
- Points System
7. Engagement Strategies
- Leaderboard System
- Games

## Installation

To set up Aklish locally:

1. Clone the repository:
```bash
git clone https://github.com/andrianllmm/aklish.git
cd aklish
```

2. Create a virtual environment:
```bash
python -m venv env
source env/bin/activate # or `env\Scripts\activate` for Windows
```

3. Install dependencies:
```bash
pip install -r requirements.txt
```

4. Apply migrations:
```bash
python manage.py migrate
```

5. Run the development server:
```bash
python manage.py runserver
```

## Configuration

Before running the application, ensure that you have configured the following settings in your .env file:

- `DATABASE_URL`: URL for the database connection.
- `SECRET_KEY`: A secret key for Django security purposes.
- `DEBUG`: Set to True for development, False for production.

## Usage

1. **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.
3. **Earn reputation**: Some features can only be accessed by earning enough reputation points.
2. **Participate**: To earn reputation, submit entries or translations, bookmark, vote, etc.
4. **Learn more**: View the help center at `/help` for more information.

## Contributing

Contributions are welcomed! To get started:

1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/your-feature
```
3. Make your changes.
4. Submit a pull request with a clear description of your changes.

## Issues

If you encounter any issues or bugs, please report them on the [GitHub issues page](https://github.com/andrianllmm/aklish/issues).

## License

This project is licensed under the [GPL-3.0 License](LICENSE).

---

For more information contact [[email protected]](mailto:[email protected]) with any additional questions or comments.