https://github.com/kstepien3/sipmle-joke-app
This application was created for demonstration purposes.
https://github.com/kstepien3/sipmle-joke-app
angular monorepo nx typescript
Last synced: about 1 month ago
JSON representation
This application was created for demonstration purposes.
- Host: GitHub
- URL: https://github.com/kstepien3/sipmle-joke-app
- Owner: kstepien3
- Created: 2022-06-29T16:47:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-10T14:12:45.000Z (almost 4 years ago)
- Last Synced: 2025-03-06T20:25:13.887Z (over 1 year ago)
- Topics: angular, monorepo, nx, typescript
- Language: TypeScript
- Homepage: https://kordrad.github.io/sipmle-joke-app
- Size: 3.78 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple Jokes APP
This application was created for presentation purposes. However, it is prepared to connect with the API.
## Run Locally
Clone the project
```bash
git clone https://github.com/Kordrad/sipmly-joke-app.git
```
Go to the project directory
```bash
cd sipmly-joke-app
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run start:web
```
or start the demo server
```bash
npm run start:web:demo
```
## API Reference
#### Add new joke
```http
POST *API_URL*/joke
```
| Parameter | Type | Description |
| :--------- | :------- | :----------------------------------------- |
| `category` | `GUID` | **Required**. GUID of existing category |
| `content` | `string` | **Required** Your funny joke. Be creative! |
#### Get Jokes list
```http
GET *API_URL*/jokes
```
#### Get Random Joke
```http
GET *API_URL*/joke/random
```
#### Delete joke
```http
DELETE *API_URL*/joke/:id
```
| Parameter | Type | Description |
| :-------- | :----- | :---------------------------------- |
| `id` | `GUID` | **Required**. GUID of existing joke |
#### Get Categories list
```http
GET *API_URL*/categories
```