Skip to content

This is the source code for my personal portfolio website built with Next.js

License

Notifications You must be signed in to change notification settings

Atharva0506/Portfolio

Repository files navigation

Sure, here's a README file for your portfolio website:


Portfolio Website

This is the source code for my personal portfolio website built with Next.js. You can view the live version of the site here.

Table of Contents

Overview

This portfolio website showcases my projects, skills, and contact information. It's built using modern web development technologies to ensure a fast and responsive user experience.

Technologies Used

  • Next.js: A React framework for server-side rendering and static site generation.
  • React: A JavaScript library for building user interfaces.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • TypeScript: A typed superset of JavaScript that adds static types.
  • Axios: A promise-based HTTP client for the browser and Node.js.
  • Mongoose: An elegant MongoDB object modeling tool for Node.js.
  • React Hot Toast: A library for displaying notifications.
  • React Icons: A library of popular icons for React.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/your-repo-name.git
    cd your-repo-name
  2. Install the dependencies:

    npm install

Running the Application

To start the development server, run:

npm run dev

The application will be available at http://localhost:3000.

To build the application for production, run:

npm run build

To start the production server, run:

npm start

Scripts

  • dev: Starts the development server.
  • build: Builds the application for production.
  • start: Starts the production server.
  • lint: Runs ESLint to analyze the code for potential errors and style issues.

Project Structure

/
├── public/         # Static assets
├── src/
│   ├── components/ # React components
│   ├── pages/      # Next.js pages
│   ├── styles/     # CSS styles
│   ├── utils/      # Utility functions
│   └── ...         # Other folders and files
├── .eslintrc.js    # ESLint configuration
├── next.config.js  # Next.js configuration
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.json   # TypeScript configuration
├── package.json    # Project dependencies and scripts
└── README.md       # Project documentation

Contributing

If you'd like to contribute to this project, please fork the repository and use a feature branch. Pull requests are warmly welcome.

  1. Fork the repository.
  2. Create a new feature branch.
  3. Commit your changes.
  4. Push to the branch.
  5. Open a pull request.

License

This project is open-source and available under the MIT License.


Feel free to customize any section according to your specific details and preferences.

About

This is the source code for my personal portfolio website built with Next.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published