This repository contains the AtmaVeda UI project, built with Next.js. It is designed to be scalable, responsive, and optimized for a seamless user experience.
Follow the steps below to set up and run the project locally.
Ensure you have the following installed:
Clone the repository:
git clone https://github.com/CYBERBULL123/AtmaVeda.git
cd AtmaVeda
Install dependencies:
# Using npm
npm install
# Or using yarn
yarn install
# Or using pnpm
pnpm install
# Or using bun
bun install
Start the development server:
# Using npm
npm run dev
# Or using yarn
yarn dev
# Or using pnpm
pnpm dev
# Or using bun
bun dev
Visit http://localhost:3000 in your browser to view the app.
app/page.tsx
: Main entry point for editing the homepage.app/styles
: Contains global and modular styles.components/
: Reusable components for the UI.
This project uses next/font
to optimize and load the Geist font family.
We welcome contributions to make AtmaVeda UI even better! Follow these steps to contribute:
- Fork the Repository: Click on the "Fork" button on GitHub to create your copy.
- Clone Your Fork: Clone the forked repository to your local machine.
- Create a Branch: Use a meaningful branch name for your feature or fix:
git checkout -b feature/your-feature-name
- Make Your Changes: Commit your changes with clear messages:
git add . git commit -m "Add a brief description of the change"
- Push Your Branch:
git push origin feature/your-feature-name
- Submit a Pull Request: Open a PR to the main repository with a clear description of your changes.
- Ensure your code follows the project's style and linting rules.
- Write clear, concise commit messages.
- Test your changes before submitting.
The easiest way to deploy this project is via Vercel.
- Connect Your Repo: Link this GitHub repository to Vercel.
- Configure Settings: Vercel will automatically detect and configure your Next.js project.
- Deploy: Click "Deploy" to build and host your project.
For detailed instructions, refer to the Next.js Deployment Documentation.
- Next.js Documentation - Learn about Next.js features and APIs.
- Interactive Next.js Tutorial - Master the basics and advanced features.
- GitHub Repository - Explore Next.js source code.
We appreciate your interest in AtmaVeda UI! 🎉
Feel free to reach out by opening issues or discussions for any questions or feedback.