Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 2.88 KB

README.md

File metadata and controls

64 lines (37 loc) · 2.88 KB
Raw

Akan-Names

A web application that takes a user's birthday and calculates the day of the week they were born and then depending on their gender outputs their Akan Name. Akan names are derived from Ghanian culture. Frequently in Ghana, children are given their first name as a 'day name' which corresponds to the day in the week they were born.

Technologies Used

  • HTML & CSS (Bootstrap)
  • JavaScript
Requirements

JSFiddle or JavaScript Console

Setup Instructions and Installation
  • Clone this repository to a location in your file system. https://github.com/MwitaBrian/Akan-Names.git
  • Open terminal command line then navigate to the root folder of the application. cd Akan-Names
  • Open index.html on your Browser.

Behaviour Driven Development

  1. Displays Form For Entering Date and Gender
    • INPUT: "User's Birthdate Entered"
    • INPUT: "User's Gender Entered"
    • OUTPUT: "Displays User's Akan Name According to Submitted Date and Gender"
  2. Click the button to see Akan name

Development

Want to contribute? Great!

To fix a bug or enhance an existing module, follow these steps:

  • Fork the repo
  • Create a new branch (git checkout -b improve-feature)
  • Make the appropriate changes in the files
  • Add changes to reflect the changes made
  • Commit your changes (git commit -am 'Improve feature')
  • Push to the branch (git push origin improve-feature)
  • Create a Pull Request

Known Bugs

If you find a bug (the website couldn't handle the query and or gave undesired results), kindly open an issue here by including your search query and the expected result.

If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.

Link to Live Site : https://mwitabrian.github.io/Akan-Names/

License

MIT Copyright (c) 2021 Mwita Brian

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.