CoolFace
Apppublic

ndamulelonemakh/afri-lang-catalog-demo-02

sourceHugging Facemitupdated 2y agoView on Hugging Face
1likes
App README

African Languages Catalog

Description

The African Languages Catalog is a web application designed to showcase and provide information about the diverse languages spoken across the African continent. This project aims to celebrate linguistic diversity, promote language preservation, and serve as an educational resource for anyone interested in African languages.

[image]

Features

  • —Browse languages by region
  • —Detailed information pages for individual languages
  • —Search functionality (planned)
  • —User-friendly interface built with Flask and styled with Tailwind CSS

Technologies Used

  • —Python 3.11+
  • —Flask
  • —SQLAlchemy
  • —SQLite (can be configured for other databases)
  • —Tailwind CSS
  • —HTML5

Installation

  1. 1.Clone the repository:
bash
   git clone https://github.com/ndamulelonemakh/afri-lingo-idx.git
   cd afri-lingo-idx.
  1. 1.Set up a virtual environment:
bash
   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  1. 1.Install the required packages:
bash
   pip install -r requirements.txt
  1. 1.Initialize the database:
bash
   python seed.py
  1. 1.Run the application:
bash
   export SECRET_KEY=<enter-a-random-secret-key>
   FLASK_APP=application flask --app application:app run --host 0.0.0.0 --reload
  1. 1.Open a web browser and navigate to http://localhost:5000

Project Structure

african-languages-catalog/
│
├── app.py
├── models.py
├── seed.py
├── requirements.txt
├── README.md
│
├── templates/
│   ├── index.html
│   ├── about.html
│   ├── category.html
│   └── language.html
│
└── static/
    └── css/
        └── styles.css

Contributing

If you'd like to contribute, please follow these steps:

  1. 1.Fork the repository
  2. 2.Create a new branch (git checkout -b feature/AmazingFeature)
  3. 3.Make your changes
  4. 4.Commit your changes (git commit -m 'Add some AmazingFeature')
  5. 5.Push to the branch (git push origin feature/AmazingFeature)
  6. 6.Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contact

Acknowledgements