This is the frontend repository for Pragati 2025, the annual fest of the Amrita School of Business (ASB). The application is built using Next.js and designed to provide a seamless user experience for event attendees and organizers.
Pragati 2025 - Frontend aims to:
- Display event schedules, participant details, and venue information.
- Offer a responsive and intuitive user interface.
- Provide real-time updates for the event.
- Getting Started
- Installation
- Usage
- Commit Guidelines
- Technologies Used
- Using
next/font/local
for Custom Fonts - Learn More
- Deploy on Vercel
- Contributing
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying src/app/page.js
. The page auto-updates as you edit the file.
This project uses next/font
to automatically optimize and load Geist, a font family by Vercel.
-
Clone the repository:
git clone https://github.com/TharunKumarrA/Pragati_Frontend_2025.git cd Pragati_Frontend_2025
-
Install dependencies:
npm install # or yarn install
-
Development Mode:
npm run dev
The app will auto-update as you make changes.
-
Production Build:
npm run build
To run the production build:
npm start
-
Commitlint has been added to
package.json
to enforce proper commit message standards. -
After pulling from the
main
branch, make sure to install it and its dependencies:npm install
-
Stage your files:
git add <files>
-
Use
npx cz
instead ofgit commit
:npx cz
This will open a guided interface to help you write commit messages that follow the required standards.
- Next.js: A React framework for server-side rendering and static site generation.
- React: A JavaScript library for building user interfaces.
- Tailwind CSS: Utility-first CSS framework for rapid UI development.
- ESLint: Tool for identifying and fixing code issues.
- PostCSS: CSS processing tool.
- Node.js: JavaScript runtime environment.
When using next/font/local
for custom fonts, font files must be placed inside the src
directory. The next/font/local
function resolves paths relative to the file that imports the font. Placing fonts in the public
directory will not work because the public
folder is meant for assets served via HTTP (e.g., images in <img src="/image.png">
).
-
Create a Fonts Directory:
Add a
fonts
folder insidesrc
, e.g.,src/fonts
.src/ └── fonts/ ├── ChicAvenue.woff └── Poppins.woff
-
Use
next/font/local
in Your Component:Import the font in your component using
next/font/local
.
- Relative Paths: The paths in
next/font/local
should be relative to the file importing the font. - Avoid Public Directory: Do not place font files in the
public
folder;next/font/local
only works with files insidesrc
. - Automatic Optimization: Fonts imported with
next/font/local
are automatically optimized by Next.js.
To learn more about Next.js, explore the following resources:
- Next.js Documentation - Learn about Next.js features and APIs.
- Learn Next.js - Interactive Next.js tutorial.
- Next.js GitHub Repository - Feedback and contributions are welcome!
The easiest way to deploy this Next.js app is via the Vercel Platform created by the Next.js team.
Refer to the Next.js deployment documentation for detailed instructions.
To contribute to this project:
-
Pull the latest changes from the
main
branch:git pull origin main
-
Create a new branch for your feature or fix:
git checkout -b feature/your-feature-name
-
Make your changes and follow the commit guidelines when committing:
git add <files> npm install --save-dev commitizen cz-conventional-changelog # Install Commitizen (if not already installed) npx cz
-
Push your branch to the remote repository:
git push origin feature/your-feature-name
-
Create a pull request from your branch to the
main
branch.
Since this is a private repository, only collaborators have access to contribute. Please ensure your pull request follows the project's coding standards and commit message guidelines.