mirror of
https://github.com/EdiFarcas/Giveaway-app.git
synced 2026-06-22 07:00:57 +03:00
Read me file
This commit is contained in:
@@ -1,36 +1,70 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
# Giveaway Site
|
||||
|
||||
A modern web application for hosting and managing giveaways, built with [Next.js](https://nextjs.org), [TypeScript](https://www.typescriptlang.org/), and [Tailwind CSS](https://tailwindcss.com/).
|
||||
|
||||
## Features
|
||||
|
||||
- ⚡ **Next.js App Router** for fast, scalable routing and SSR/SSG.
|
||||
- 🛠️ **TypeScript** for type safety and better developer experience.
|
||||
- 🎨 **Tailwind CSS** for utility-first, responsive UI design.
|
||||
- 🗂️ **App Directory Structure** for modular, maintainable code.
|
||||
- 🔤 **next/font** for optimized font loading (Geist).
|
||||
- 🔒 **Environment Variables** for secure configuration.
|
||||
- 🚀 **Ready for Vercel Deployment** with zero-config.
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
1. **Install dependencies:**
|
||||
```bash
|
||||
npm install
|
||||
# or
|
||||
yarn install
|
||||
# or
|
||||
pnpm install
|
||||
# or
|
||||
bun install
|
||||
```
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
2. **Run the development server:**
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
3. Open [http://localhost:3000](http://localhost:3000) in your browser.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
## Project Structure
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
- `app/` — Main application pages and routes.
|
||||
- `components/` — Reusable UI components.
|
||||
- `styles/` — Global and Tailwind CSS styles.
|
||||
- `public/` — Static assets.
|
||||
- `next.config.js` — Next.js configuration.
|
||||
- `tsconfig.json` — TypeScript configuration.
|
||||
|
||||
## Technologies Used
|
||||
|
||||
- **Next.js** — React framework for production.
|
||||
- **TypeScript** — Static typing for JavaScript.
|
||||
- **Tailwind CSS** — Utility-first CSS framework.
|
||||
- **next/font** — Font optimization.
|
||||
- **Vercel** — Deployment platform.
|
||||
|
||||
## Deployment
|
||||
|
||||
Deploy instantly to [Vercel](https://vercel.com/) for best performance and global reach.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
- [Next.js Documentation](https://nextjs.org/docs)
|
||||
- [TypeScript Docs](https://www.typescriptlang.org/docs/)
|
||||
- [Tailwind CSS Docs](https://tailwindcss.com/docs)
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
---
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
Feel free to contribute or open issues to improve the project!
|
||||
|
||||
Reference in New Issue
Block a user