Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngkhang/countries-in-the-world
https://github.com/ngkhang/countries-in-the-world
pet-project reactjs typescript vite
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ngkhang/countries-in-the-world
- Owner: ngkhang
- Created: 2023-10-30T17:00:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-02T12:19:41.000Z (about 1 year ago)
- Last Synced: 2024-11-20T06:15:07.728Z (2 months ago)
- Topics: pet-project, reactjs, typescript, vite
- Language: TypeScript
- Homepage: https://countriesinthewolrd.onrender.com
- Size: 127 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Countries in the World
Table of Contents:
- [Countries in the World](#countries-in-the-world)
- [About this project](#about-this-project)
- [Challenges](#challenges)
- [Features](#features)
- [Technologies](#technologies)
- [Demo](#demo)
- [Screenshots](#screenshots)
- [Liveview](#liveview)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Environment Variables](#environment-variables)
- [Available Scripts](#available-scripts)
- [Run the app Dev mode](#run-the-app-dev-mode)
- [Lint](#lint)
- [Preview app](#preview-app)
- [Built app](#built-app)
- [Folder Structure](#folder-structure)
- [Contributing](#contributing)
- [Author](#author)
Refrence from Vite
- This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
- Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
- Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level `parserOptions` property like this:
```js
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
```
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
---
## About this project
- Description:
- This is a boilerplate for React project using Vite, TypeScript, React Router DOM, Tailwind CSS, ESLint, and Airbnb Guide Style.
- If needed, you can install other frameworks or libraries.
### Challenges
- Using....
### Features
- Features...
### Technologies
- This project was bootstrapped with:
- **Vite**:
- **React**:
- **React Router DOM**:
- **TypeScript**:
- React + TypeScript:
- **Tailwind CSS**:
- **ESLint**:
- **Airbnb Guide Style**:
- React:
- **React Icons**:
## Demo
### Screenshots
Toggle Show/Hide:
### Liveview
- Link: [Live](https//)
## Getting Started
### Installation
1. Clone this respository
``` powershell
git clone https://github.com/ngkhang/countries-in-the-world.git
```
2. Change to the project directory
``` powershell
cd countries-in-the-world
```
3. Install the dependencies:
``` powershell
npm i
```
### Environment Variables
You can also checkout .env.example file
`API_KEY`
### Available Scripts
In the project directory, you can run:
#### Run the app Dev mode
- `npm run dev`: With localhost
Run command `npm run dev` and open to view it in the browser.
- `npm run dev:host`: With localhost and network
``` powershell
➜ Local: http://localhost:5173/
➜ Network: http://YOUR_IP:5173/
```
#### Lint
- The project uses ESLint and Airbnb Guide Style to lint the code. To run the linters, use the following commands:
- `npm run lint`: Check lint.
- `npm run lint:fix`: Auto fix some errors
#### Preview app
- Preview project before build production. You can run `npm run build` before preivew app.
- `npm run preview`: With localhost
Run command below and open to view it in the browser.
- `npm run preview:host`: With localhost and network
``` powershell
➜ Local: http://localhost:8080/
➜ Network: http://YOUR_IP:8080/
```
#### Built app
`npm run build`: Builds the app for production to the `dist` folder.
- The project can be deployed to a variety of platforms, such as Render, Firebase, Netlify, or Vercel.
---
## Folder Structure
The code for the project is organized as follows:
``` markdown
.
├── .vscode
├── node-modules
├── public
├── src/
│ ├── assets
│ ├── components/
│ │ ├── generic/
│ │ │ ├── Header
│ │ │ └── ...
│ │ └── layout/
│ │ ├── defaultLayout
│ │ └── index.tsx
│ ├── hooks
│ │ └── useCustom.tsx
│ ├── pages/
│ │ └── HomePage
│ │ └── PageNotPound
│ ├── routes/
│ │ └── index.tsx
│ ├── services/
│ │ └── api
│ ├── types
│ ├── utils/
│ │ ├── constants/
│ │ │ ├── dbPage.json
│ │ │ └── index.tsx
│ │ ├── functions/
│ │ │ └── handleFunc.tsx
│ │ └── helpers/
│ │ └── icons.tsx
│ ├── App.css
│ ├── App.tsx
│ ├── index.css
│ ├── main.tsx
│ └── vite-env.d.ts
├── .editorconfig
├── .env
├── .eslintignore
├── .eslintrc.cjs
├── .gitignore
├── index.html
├── package-lock.json
├── package.json
├── postcss.config.js
├── README.md
├── tailwind.config.js
├── tsconfig.json
├── tsconfig.node.json
└── vite.config.js
```
---
## Contributing
- Contributions are welcome! Please open an issue or a pull request if you have any ideas for improvement.
- Give a ⭐️ if this project helped you!
---
## Author
👤 **Khang Nguyen**
[](https://ngkhang.onrender.com/)
[](https://linkedin.com/in/ngkhang0220)
[](https://github.com/ngkhang)
[](https://github.com/ngkhang)