heraldry-search-front

A web app to search French armorial data (cities, villages, families), powered by heraldry-crawler and Algolia.

Features

• 📖 Data from Wikipedia armorials heraldry-crawler
  • 🏙 French cities
  • 🏘 French villages
  • 👨‍👩‍👧‍👦 French families
  • more are coming...
• 🔍 Simple and powerful search by Algolia

Get started

1. Create .env file from .env.sample and complete it with the Algolia app settings in your console.

REACT_APP_SEARCH_SERVICE=     # Search service `algolia` OR `custom`
REACT_APP_ALGOLIA_APP_ID=     # Aloglia app ID
REACT_APP_ALGOLIA_API_KEY=    # Algolia API Key
REACT_APP_ALGOLIA_INDEX=      # Algolia index name
REACT_APP_CUSTOM_SEARCH_URL=  # if `custom` search service, heraldry-crawler server url

2. Install dependencies and start the app:

npm install
npm start
# or
yarn
yarn start

3. Open http://localhost:3000 to view the app.

Contributing

Pull requests are welcome!

License

MIT