Dailyctionary is a bot to scrap random words from dictionaries and send their meanings by e-mail. I designed this project because I wanted to improve my Spanish vocabulary with a passive way and without deeply studying.
# Clone Repository
$ git clone https://github.com/LuanSilveiraSouza/dailyctionary.git# Go to folder
$ cd dailyctionary
# Install Packages
$ npm install
# See .example.env and create a .env file with your credentials to nodemailer
$ touch .env
# Run Application
$ npm start
# Run Tests
$ npm testFeel free to open new issues and colaborate with others issues in Dailyctionary Issues
There are many forms to contribute with the project, first of all you can give this github repo a Star.
If you want do help with the code follow the steps bellow
# Fork this Repository https://github.com/LuanSilveiraSouza/dailyctionary.git
# Clone your fork
$ git clone {your-fork-url}
$ cd dailyctionary
# Create a branch with your feature
$ git checkout -b {branch-name}
# Make the commit with your changes
$ git commit -m 'Feat: {feature-name}'
# Send the code to your remote branch
$ git push origin {branch-name}Then send a Pull Request that will be analyzed and approved if it helps with the project.
Currently the bot only have implemented it flow for Spanish Language, but I designed thinking to support for other languages in future additions. If you really want to contribute, consider that the primarly objective of this project!
Released in 2020 under MIT License
Made with ❤️ by Luan Souza.