https://github.com/victorokoroji/makeup-app
This application shows information about a makeup product called 'Foundation'. It is built around an API to fetch the needed data. It can show information on a particular brand and type of foundations. This app helps to promote the business of makeups and enable users to select there desired makeup effortlessly
https://github.com/victorokoroji/makeup-app
css jest react react-testing-library redux
Last synced: 2 months ago
JSON representation
This application shows information about a makeup product called 'Foundation'. It is built around an API to fetch the needed data. It can show information on a particular brand and type of foundations. This app helps to promote the business of makeups and enable users to select there desired makeup effortlessly
- Host: GitHub
- URL: https://github.com/victorokoroji/makeup-app
- Owner: victorokoroji
- Created: 2022-04-22T10:26:39.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-24T13:12:17.000Z (about 3 years ago)
- Last Synced: 2025-04-10T00:56:48.257Z (2 months ago)
- Topics: css, jest, react, react-testing-library, redux
- Language: JavaScript
- Homepage: https://makeupapp.netlify.app/
- Size: 4.18 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MakeUp App
The application shows information about the varieties of makeup called 'Foundation'. It is built around an API to fetch the needed data. It can show information on a particular brand and type of foundations. This app helps to promote the business of makeups and enable users to select there desired makeup effortlessly
## Built With
- React (A free and open-source front-end JavaScript library for building user interfaces based on UI components)
- Stylelint (A mighty, modern linter that helps you avoid errors and enforce conventions in your styles).
- ESlint (A mighty, modern linter that helps you avoid errors and enforce conventions in JavaScript codes)
- Redux
- GitFlow.
## Live Demo
- [Live Demo Link](https://makeupapp.netlify.app/)
- [Project Video Demo](https://www.loom.com/share/0728c31d1cb44a839f42e999bbdca97d)
### Prerequisites
The basic requirements for building the executable are:
- A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)
- Have a good knowledge on how to parse UI designs
- Have VSCode or other text editor installed. [Link to download VSCode](https://code.visualstudio.com/download)
- Install node package. [Link to download node](https://nodejs.org/en/download/)
- Have git installed.[Link to download git](https://git-scm.com/downloads)
- Create a github repository.
## Getting Started
To get a local copy up and running follow these simple example steps.
#### Cloning the project
```
git clone https://github.com/vickymarz/make-up-app.git
```
```
cd
```
## Getting packages and dependencies
To get all package modules required to build the project run:
```
npm install
```
every package module required to build the project is listed in the package.json file. this is used as a reference to get all dependencies.
## Running
To run the program on a browser through a server run this command in your cli
```
npm start
```
This should open the page in your localhost on port 3000. then you'd be able to view the built page generated using webpack.
## Run tests
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
For tracking linters errors locally, you need to follow these steps:
- For tracking linter errors in CSS file run:
```
npx stylelint "**/*.{css,scss}"
```
- For tracking linter errors in Javascript file run:
```
npx eslint .
```
## Building
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## 🤝 Contributing
Feel free to check the [issues page](../../issues/).
👤 **Okoroji Victor aka Vickymarz**
- GitHub: [@githubhandle](https://github.com/vickymarz)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/okoroji-victor-ebube-8791741a0)
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Microverse
- [Nelson Sakwa on Behance(original app design)](https://www.behance.net/gallery/31579789/Ballhead-App-%28Free-PSDs%29)
## 📝 License
This project is [MIT](./MIT.md) licensed.