Skip to content

Embark on a transformative journey with AI-powered exploration of Vedic scriptures, Indian philosophy, and the rich cultural heritage of Sanatan Dharma.

Notifications You must be signed in to change notification settings

CYBERBULL123/AtmaVeda

Repository files navigation

AtmaVeda UI

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.

Getting Started

Follow the steps below to set up and run the project locally.

Prerequisites

Ensure you have the following installed:

Installation

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

Running the Development Server

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.

File Structure

  • app/page.tsx: Main entry point for editing the homepage.
  • app/styles: Contains global and modular styles.
  • components/: Reusable components for the UI.

Fonts

This project uses next/font to optimize and load the Geist font family.


Contributing

We welcome contributions to make AtmaVeda UI even better! Follow these steps to contribute:

  1. Fork the Repository: Click on the "Fork" button on GitHub to create your copy.
  2. Clone Your Fork: Clone the forked repository to your local machine.
  3. Create a Branch: Use a meaningful branch name for your feature or fix:
    git checkout -b feature/your-feature-name
  4. Make Your Changes: Commit your changes with clear messages:
    git add .
    git commit -m "Add a brief description of the change"
  5. Push Your Branch:
    git push origin feature/your-feature-name
  6. Submit a Pull Request: Open a PR to the main repository with a clear description of your changes.

Contribution Guidelines

  • Ensure your code follows the project's style and linting rules.
  • Write clear, concise commit messages.
  • Test your changes before submitting.

Deployment

The easiest way to deploy this project is via Vercel.

  1. Connect Your Repo: Link this GitHub repository to Vercel.
  2. Configure Settings: Vercel will automatically detect and configure your Next.js project.
  3. Deploy: Click "Deploy" to build and host your project.

For detailed instructions, refer to the Next.js Deployment Documentation.


Resources


We appreciate your interest in AtmaVeda UI! 🎉
Feel free to reach out by opening issues or discussions for any questions or feedback.

About

Embark on a transformative journey with AI-powered exploration of Vedic scriptures, Indian philosophy, and the rich cultural heritage of Sanatan Dharma.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages