From e43db1fc3ded71be1c4d938ac2a7ffbc0e6ac623 Mon Sep 17 00:00:00 2001 From: Mohammed Rabil Date: Thu, 25 Apr 2024 17:44:52 +0530 Subject: [PATCH] Update README.md with Tiara 2024 website details --- README.md | 68 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 45 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c403366..b5aab9c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,58 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Tiara 2024 Website -## Getting Started +Tiara is a platform for young minds aspiring to be extraordinary. It's a National-level Techno-Cultural fest, open to all college students, where participants can showcase their talents and represent their respective institutions on the grand stage of Tiara. Our event aims to spread awareness and knowledge in new areas of Technology and Culture to contribute to the nation's development. -First, run the development server: +### Event Details -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +Join us at Tiara 2024 to unleash your potential, explore new horizons, and contribute to the development of our nation through technology and culture! -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +- **Date:** May 9th, 10th, and 11th, 2024. +- **Location:** St Joseph Engineering College, Vamanjoor, Mangaluru, Karnataka, India. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +Visit [tiarasjec.in](https://tiarasjec.in/) to learn more about Tiara 2024. -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +## Technologies Used -## Learn More +Tiara 2024 website is built using Next.js and Prisma ORM. We utilize a serverless PostgreSQL database with Neon DB. -To learn more about Next.js, take a look at the following resources: +- **Frontend:** Next.js, React, Tailwind CSS. +- **Backend:** Next.js API Routes, Prisma ORM with PostgreSQL. +- **Database:** Neon DB (Serverless PostgreSQL). +- **CDN:** GCP (Google Cloud Platform) cloud storage buckets, provisioned by a CDN with Load balancer. +- **Deployment:** [Vercel](https://vercel.app/) -- [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. +## Getting Started + +To get started with the Tiara 2024 website locally: + +1. Clone this repository. +2. Install dependencies using `npm install`. +3. Copy the `.env.example` file to `.env` and insert the environment variables. +4. Run the development server: + ```bash + npm run dev + ``` +5. Open [http://localhost:3000](http://localhost:3000) in your browser to view the website. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +## Building for Production -## Deploy on Vercel +To build the Tiara 2024 website for production: -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. +1. Make sure you have environment variables setup. +2. Run the build command: + ```bash + npm run build + ``` +3. Start the production server: + ```bash + npm start + ``` +4. Open [http://localhost:3000](http://localhost:3000) in your browser to view the website. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. + +### Learn More + +To learn more about Next.js, take a look at the following resources: + +- [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. \ No newline at end of file