Sprint 5 - Joke Generator

Joke Generator that changes color scheme and blob layouts on button click. Developed primarily in Typescript with REST API calls.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is Sprint 5 of the Barcelona Activa Cibernarium course on Front-end with Angular. THe aim of this project is to create an app that displays jokes by accessing two different REST APIs. The scripting code is developed in Typescript with minimal JQuery functions displayed within the main html page.

(back to top)

Built With

• Typescript
• CSS
• Node
• JQuery

(back to top)

Getting Started

Clone repository then do npm install.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://www.weatherapi.com/.
2. Clone the repo

   git clone https://github.com/cplan85/Sprint5-Acudits.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = "ENTER YOUR API";

(back to top)

Usage

For a little de-stressor, check the latest Dad, Geek, or Chuck Norris jokes, and rate them!

(back to top)

Roadmap

• API calls to Joke APIS
• Get local Weather Data
• update Color Scheme based on API
• save user's favorited jokes

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

• https://icanhazdadjoke.com/
• https://github.com/sameerkumar18/geek-joke-api
• https://www.weatherapi.com/
• http://colormind.io/api-access/
• https://fontawesome.com/
• https://github.com/public-apis/public-apis

(back to top)