doraboateng/web

Connect with your Indigenous and African heritage. Here lies the source for for Dora Boateng, a free tool dedicated to preserving and promoting our languages and heritage. _Looking to add or update content? Shoot us an email at dora@kwcay.co._ _Looking to contribute to our source code? Read our contribution notes here._ ## Table of contents - Setting up your local environment - Reporting Bugs - Reporting Security Issues - Contributing - License ## Setting up your local environment Software requirements Make sure the following software is installed on your local machine: - Git - Node - Yarn **Optional, but recommended:** - Visual Studio Code Once you have the required software, you can run the app locally from a terminal: ```shell # Clone the source code locally. git clone git@github.com:doraboateng/web.git cd boateng-web # Install the dependencies. yarn install # Run the app. yarn dev ``` The app will be available at the URL: localhost ## Reporting bugs >TODO ## Reporting security issues >TODO ## Contributing Read our contribution notes here ## License GNU General Public License v3 Copyright © Kwahu & Cayes