Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikolajszymczuk1/rest-countries-api-with-color-theme-switcher-master
https://github.com/mikolajszymczuk1/rest-countries-api-with-color-theme-switcher-master
api api-rest jest pinia tailwindcss vue vuejs
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mikolajszymczuk1/rest-countries-api-with-color-theme-switcher-master
- Owner: mikolajszymczuk1
- Created: 2022-07-07T00:55:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-24T01:06:29.000Z (over 2 years ago)
- Last Synced: 2024-04-28T06:27:43.780Z (7 months ago)
- Topics: api, api-rest, jest, pinia, tailwindcss, vue, vuejs
- Language: JavaScript
- Homepage: https://delicate-lollipop-e8af06.netlify.app/
- Size: 1.63 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Frontend Mentor - REST Countries API with color theme switcher solution
This is a solution to the [REST Countries API with color theme switcher challenge on Frontend Mentor](https://www.frontendmentor.io/challenges/rest-countries-api-with-color-theme-switcher-5cacc469fec04111f7b848ca). Frontend Mentor challenges help you improve your coding skills by building realistic projects.
## Table of contents
- [Overview](#overview)
- [The challenge](#the-challenge)
- [Screenshot](#screenshot)
- [Links](#links)
- [My process](#my-process)
- [Built with](#built-with)
- [What I learned](#what-i-learned)
- [Continued development](#continued-development)
- [Author](#author)
- [Acknowledgments](#acknowledgments)
- [Run Project](#how-to-run-project)
## Overview
### The challenge
Users should be able to:
- See all countries from the API on the homepage
- Search for a country using an `input` field
- Filter countries by region
- Click on a country to see more detailed information on a separate page
- Click through to the border countries on the detail page
- Toggle the color scheme between light and dark mode *(optional)*
### Screenshot
### Links
- Solution URL: [Solution](https://www.frontendmentor.io/solutions/vue-3-compositionapi-tailwindcss-pinia-vue-router-5is1IiuBYE)
- Live Site URL: [Live](https://delicate-lollipop-e8af06.netlify.app/)
## My process
### Built with
- Semantic HTML5 markup
- [TailwindCSS](https://tailwindcss.com/) - CSS Framework
- Mobile-first workflow
- [Vue.js](https://vuejs.org/) - front-end framework Vue3 | Composition API
- [Jest](https://jestjs.io/) - for unit testing
- [Pinia](https://pinia.vuejs.org/) - Vue 3 state management library
- [Cypress](https://www.cypress.io/) - for end to end testing
### What I learned
Mastering Vue <3
### Continued development
I want to complete these challenges using vue :)
## Author
- Github - [Mikołaj Szymczuk](https://github.com/mikolajszymczuk1)
- Frontend Mentor - [@mikolajszymczuk1](https://www.frontendmentor.io/profile/mikolajszymczuk1)
## Acknowledgments
```js
LOVE VUE <3
```
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```