https://github.com/alitindrawan24/nuxt-pokedex
https://github.com/alitindrawan24/nuxt-pokedex
hacktoberfest hacktoberfest-accepted hacktoberfest2024 pokedex pokemon
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alitindrawan24/nuxt-pokedex
- Owner: Alitindrawan24
- Created: 2024-04-12T18:21:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-31T15:39:44.000Z (12 months ago)
- Last Synced: 2025-01-16T01:14:45.429Z (9 months ago)
- Topics: hacktoberfest, hacktoberfest-accepted, hacktoberfest2024, pokedex, pokemon
- Language: Vue
- Homepage: https://nuxt-pokedex-omega.vercel.app
- Size: 409 KB
- Stars: 8
- Watchers: 2
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 Nuxt 3 Minimal Starter
Welcome to the **Nuxt 3 Minimal Starter**! This project provides a lightweight, efficient starting point for building applications with [Nuxt 3](https://nuxt.com/docs/getting-started/introduction).
## 🌟 Features
- **Nuxt 3**: Enjoy the latest version of the progressive Vue.js framework.
- **Zero Config**: Start building right away, with minimal setup required.
- **Hot Module Replacement**: Instant updates while developing.
- **TypeScript Support**: Fully supports TypeScript, out of the box.
## 🛠️ Setup
To get started, install the dependencies using your package manager of choice:
```bash
# npm
npm install
```
```
# pnpm
pnpm install
```
```
# yarn
yarn install
```
```
# bun
bun install
```
## 🚧 Development Server
Launch the development server on http://localhost:3000:
```
# npm
npm run dev
```
```
# pnpm
pnpm run dev
```
```
# yarn
yarn dev
```
```
# bun
bun run dev
```
## 🏗️ Production Build
Build the project for production to get it ready for deployment:
```
# npm
npm run build
```
```
# pnpm
pnpm run build
```
```
# yarn
yarn build
```
```
# bun
bun run build
```
After building, preview the production version locally:
```
# npm
npm run preview
```
```
# pnpm
pnpm run preview
```
```
# yarn
yarn preview
```
```
# bun
bun run preview
```
## 🚀 Deployment
To deploy your Nuxt 3 application, follow the official [Nuxt 3 Deployment Guide](https://nuxt.com/docs/getting-started/deployment).
### Popular Deployment Platforms:
- **Vercel**: Deploy instantly with zero configuration.
- **Netlify**: Offers seamless integration for Nuxt applications.
- **Heroku**: Customize your deployment environment with Heroku.
- **AWS, Azure, DigitalOcean**: Use Docker to deploy your application on these platforms.
To deploy:
1. Build your application using:
```bash
npm run build
2. Preview the built application locally to ensure it's ready:
```bash
npm run preview
```
3. Follow your chosen platform’s deployment instructions.
For more information, refer to the full [Nuxt 3 Deployment Documentation](https://nuxt.com/docs/getting-started/deployment).
## 📂 Project Structure
Here’s an overview of the important files and directories in a typical Nuxt 3 project:
├── assets/
├── components/
├── layouts/
├── middleware/
├── pages/
├── plugins/
├── public/
├── store/
├── nuxt.config.ts/
├── app.vue/
└── package.json
- **`pages/`**: Every `.vue` file becomes a route in the application.
- **`components/`**: Contains reusable Vue components.
- **`layouts/`**: Defines app-wide layouts.
- **`plugins/`**: Where you can inject custom Vue plugins.
- **`nuxt.config.ts`**: Configuration for your Nuxt project, such as plugins, modules, and settings.
## 🔧 Useful Commands
Here are some additional handy commands:
1. Linting: Keep your code clean
```
npm run lint
```
2. Format Code: Auto-format your code
```
npm run format
```
3. Generate Static Pages (for static hosting):
```
npm run generate
```
## 🤝How to make Contribution
We welcome contributions from developers of all skill levels! Whether you're fixing a bug, adding new features, or improving documentation, your help is appreciated.
To contribute:
1. ⭐ Star the repository to show your support.
2. 📝 Create an issue outlining how you'd like to contribute to the project.
3. 🍴 Fork the repository to make your own copy:
```sh
# Click on the "Fork" button at the top right of the repository page
4. 💻 Implement your changes in the forked repository by creating a new branch for your feature or fix:
```
git checkout -b feature-or-fix-name
```
5. Make your changes and commit them using Conventional Commits:
```
git commit -m "feat: describe your changes"
```
6. 🔄 Push your branch:
```
git push origin feature-or-fix-name
```
7. Open a pull request and describe the changes you made, mentioning the issue number you're addressing.
8. ⏳ Wait for review and feedback from the maintainers.
## 📖 Documentation
Learn more about Nuxt 3 by checking the [official Nuxt 3 Documentation](https://nuxt.com/docs/getting-started/introduction).