https://github.com/iank-code/advice-generator-app
This is a simple web app that generates a random advice message when the dice button is clicked.
https://github.com/iank-code/advice-generator-app
api css3 html5 javascript reactjs
Last synced: 2 months ago
JSON representation
This is a simple web app that generates a random advice message when the dice button is clicked.
- Host: GitHub
- URL: https://github.com/iank-code/advice-generator-app
- Owner: Iank-code
- License: gpl-3.0
- Created: 2023-11-15T14:18:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-17T12:00:13.000Z (over 2 years ago)
- Last Synced: 2024-10-18T19:28:20.850Z (over 1 year ago)
- Topics: api, css3, html5, javascript, reactjs
- Language: CSS
- Homepage: https://advice-generator-app-olive.vercel.app
- Size: 149 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Random Advice Generator
This is a web application that generates random advice when the dice button is clicked
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
### Built With
This project is built with React js and Typescript
- ![Typescript][Typescript]
- [![React][React.js]][React-url]
## Getting Started
To get a local copy up and running follow these simple example steps.
### Installation
To set up your project, you will need to clone the project and install the dependencies. Below is a list of the available commands
1. Clone the repo
```sh
git clone git@github.com:Iank-code/advice-generator-app.git
cd advice-generator-app
```
2. Install NPM packages
```sh
npm install
```
3. Creat .env.local file and add the environment variable
```sh
touch .env.local
VITE_ADVICE_API=https://api.adviceslip.com/
```
4. Start React server
```
npm run dev
```
## Usage
To generate a random advice, click the dice button and it will immediately generate a random advice
## License
Distributed under the GNU GENERAL PUBLIC LICENSE. See `LICENSE` for more information.
[product-screenshot]: ./src/assets/desktop.png
[Typescript]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/