https://github.com/dracudev/joke-app
Web app that displays random jokes from external API's using TypeScript.
https://github.com/dracudev/joke-app
api async-await es6 javascript rest-api typescript
Last synced: about 2 months ago
JSON representation
Web app that displays random jokes from external API's using TypeScript.
- Host: GitHub
- URL: https://github.com/dracudev/joke-app
- Owner: dracudev
- Created: 2024-11-07T13:10:01.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-24T22:05:40.000Z (about 2 months ago)
- Last Synced: 2025-03-24T23:19:52.945Z (about 2 months ago)
- Topics: api, async-await, es6, javascript, rest-api, typescript
- Language: JavaScript
- Homepage:
- Size: 79.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Joke App
## 📄 Description
This project focuses on building a web application that displays jokes to employees before the start of their workday. The app will fetch jokes from a public API and show them in a dynamic interface. It aims to enhance user productivity by incorporating humor into the work environment. The application will also track the user's feedback on each joke to gather insights for the client.
### Objectives
- Learn to consume data from a public REST API using TypeScript.
- Implement asynchronous JavaScript techniques like `async/await` and promises.
- Develop a user-friendly interface to display jokes and allow feedback.
- Track joke engagement and generate reports on user interactions.
## 💻 Technologies Used
- TypeScript
- JavaScript (ES6)
- Fetch API
- CSS & Bootsrap
## 📋 Requirements
- **Node.js**
- **TypeScript**
- **Fetch API** (or equivalent for making API calls)
## 🛠️ Installation
1. Clone this repository:
```bash
git clone https://github.com/dracudev/S4-TypeScript-API.git
```
2. Navigate to the project directory:
```bash
cd S4-TypeScript-API
```
3. Open the project in your text editor and start coding.
```bash
code .
```
## ▶️ Execution
1. Install the dependencies and run the TypeScript code to see it compiled into JavaScript.
```bash
npm install
tsc -w
```
2. Open index.html in a browser (recommended to use the Live Server plugin in Visual Studio Code for auto-refresh).