English Pronunciation by Faith Pellas

Deployed on GitHub pages.

Development

Setup

• Clone the repository with git clone git@github.com:fbpellas/fbpellas.github.io.git
• Go into the repository (e.g. with cd)
• Run nvm use
• Verify versions with node -v and npm -v
• Run npm i to install the dependencies

Start

• To run it locally, run npm start, it has hot reloading
• To run the test suite (no need to run command above), run npm test

Deploy

• Commit and push your changes to main branch
• Then run npm run deploy
• It will create a commit in master branch

Contribute

• This project is considered complete from a content perspective but the code quality can drastically be improved. For instance by breaking App.tsx file down into more components, TypeScript typings can be used more frequently, etc. More unit tests could be added as well. Long story short it has been implemented quickly as a hackathon. For all these reasons, only Issues about the actual website (e.g. content, bugs, etc.) are welcomed. No issues about the code is welcomed yet. Thank you!

License

This repository having no license is not an oversight. Please read more about it here