https://github.com/ompreetham/advice-generator-app
Advice Generator App built using React and SCSS, following the BEM (Block Element Modifier) naming convention. It is created as a solution to the Frontend Mentor challenge.
https://github.com/ompreetham/advice-generator-app
advicegenerator adviceslip-api bem css front-end front-end-development frontend frontend-mentor frontendmentor-challenge generator html javascript js json react render scss vite website
Last synced: 3 months ago
JSON representation
Advice Generator App built using React and SCSS, following the BEM (Block Element Modifier) naming convention. It is created as a solution to the Frontend Mentor challenge.
- Host: GitHub
- URL: https://github.com/ompreetham/advice-generator-app
- Owner: OmPreetham
- License: mit
- Created: 2024-04-13T10:24:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T02:38:06.000Z (about 2 years ago)
- Last Synced: 2024-04-17T08:04:58.814Z (about 2 years ago)
- Topics: advicegenerator, adviceslip-api, bem, css, front-end, front-end-development, frontend, frontend-mentor, frontendmentor-challenge, generator, html, javascript, js, json, react, render, scss, vite, website
- Language: SCSS
- Homepage: https://ompreetham.github.io/advice-generator-app/
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Advice Generator App
This project is a simple advice generator app built using React and SCSS, following the BEM (Block Element Modifier) naming convention. It is created as a solution to the [Frontend Mentor](https://www.frontendmentor.io/) challenge.
## Features
- Generates random advice fetched from the Advice Slip JSON API.
- Responsive design for mobile, tablet, and desktop.
- SCSS for styling, organized with BEM naming convention.
- Built with Vite for fast development and bundling.
## Technologies Used
- React
- SCSS (Sass)
- Vite (Frontend build tool)
- HTML
- JavaScript
### Previews
Desktop
Mobile
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Make sure you have Node.js and npm (or yarn) installed on your machine.
### Installation
1. Clone this repository to your local machine using the following command:
```
git clone https://github.com/OmPreetham/advice-generator-app.git
```
1. Navigate into the project directory:
```
cd advice-generator-app
```
1. Install dependencies using npm:
```
npm install
```
## Usage
To run the project, use the following command:
```
npm run dev
```
This will start a development server and open the project in your default web browser. Any changes you make to the source code will be hot-reloaded, meaning you can see the updates in real-time.
## Build
To build the project for production, use the following command:
```
npm run build
```
This will start a development server and open the project in your default web browser. Any changes you make to the source code will be hot-reloaded, meaning you can see the updates in real-time.
## Build
To build the project for production, use the following command:
This will create an optimized build of the project in the `dist` directory.
## Additional Information
- This project was scaffolded using Vite, a blazing fast frontend build tool.
- It uses React for building the user interface.
- Feel free to customize the project according to your needs.
## License
This project is licensed under the [MIT License](LICENSE).