https://github.com/codewithmide/advisor
Random advise quote generator with a text to speech feature.
https://github.com/codewithmide/advisor
react sass speech-synthesis typescript typescript-react
Last synced: 3 months ago
JSON representation
Random advise quote generator with a text to speech feature.
- Host: GitHub
- URL: https://github.com/codewithmide/advisor
- Owner: codewithmide
- Created: 2023-02-19T16:02:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-22T11:48:16.000Z (about 3 years ago)
- Last Synced: 2025-01-12T13:24:12.073Z (about 1 year ago)
- Topics: react, sass, speech-synthesis, typescript, typescript-react
- Language: TypeScript
- Homepage: https://codewithmide.github.io/advisor/
- Size: 2.98 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Advisor
## Description
Welcome to the Advisor app repository! This project is a web application that generates random pieces of advice using an API, and it is built using TypeScript and SCSS.
## Usage
**To use this application, follow the steps below:**
- Clone the repository to your local machine.
```bash
git clone https://github.com/codewithmide/advisor.git
```
- Install the dependencies.
```bash
npm install
```
- Start the development server.
```bash
npm start
```
- Then the application will be available at .
## API
The Advisor app uses a third-party API to generate random pieces of advice. The API used is [Quotable](https://github.com/lukePeavey/quotable), which provides a collection of advice statements that the application can use.
## Technology
The application is built using TypeScript, which is a statically typed superset of JavaScript. This helps to prevent bugs and improve the overall reliability of the code. The styling for the application is written in SCSS, which is a preprocessor that allows for more powerful and flexible CSS styling.
## Contributions and Issues
This repository is open-source, so feel free to contribute to the project by submitting a pull request. If you find any bugs or issues, please report them by opening an issue on the repository.
Thank you for using the Advisor app! We hope that the advice generated by this application is helpful and thought-provoking.