Noam generate wordlists used for spelling bee purposes. It provides a way for spellers to test their spelling skills and improve their vocabulary. It also provides a way for teachers to create wordlists for their students to practice.
Wordlists contain the following categories:
- Words
- Definitions
- Pronunciations
- Parts of Speech
- Sentences
- Etymology
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Node 19.7.0
Python 3.9 or higher
apt-get update
apt-get install python
apt-get install nodejs
A step by step series of examples that tell you how to get a development env running
either pipfile or requirements.txt can be used
npm install
pip install requirements.txt
pipenv install
Run the following command to start the application
npm run start
This filling out and submitting the form will generate a wordlist in the form of a downloadable spreadsheet.
A Wordlist length must be specified between 1 to 600 words & an Api Key must be provided; Which can be found here.
Located in tests folder at src/test
- form.test.tsx
- navbar.test.tsx
- promo.test.tsx
npm run test
If you see an issue or would like to contribute, please do & open a pull request or ticket for/with new features or fixes
- Justin Zhang - Initial work - JustinZhang17
This project is licensed under the MIT License - see the LICENSE.md file for details
Being deployed on Vercel, the application uses Serverless functions, so it might take a while to load/spin-up initially