Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add Readme file
  • Loading branch information
Deepak-Mahanta authored Nov 10, 2024
1 parent 067ab90 commit 8a36973
Showing 1 changed file with 52 additions and 5 deletions.
57 changes: 52 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,55 @@
# React + Vite
# University Website

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Overview

Currently, two official plugins are available:
This university website is built using React.js and CSS, providing a platform to showcase university programs, an about section, campus details, and testimonials. It includes a contact form integrated with Web3Forms to facilitate easy communication with visitors.
## Features

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
- Developed and deployed a fully responsive college/university website, ensuring cross-device and cross-browser compatibility. Enhanced user interaction with features like smooth scrolling, dynamic sliders, and an integrated contact form. Achieved significant improvement in front-end performance, emphasizing responsive design and user experience.
## Installation

To run the University Website locally, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/yourusername/Edusity.git
```

2. Navigate to the project directory:

```bash
cd Edusity
```

3. Install dependencies:

```bash
npm install
```

4. Start the development server:

```bash
npm run dev
```

5. Open your web browser and navigate to `http://localhost:3000` to view the website.

## Technologies Used

- **Frontend**: React.js, HTML, CSS
- **Email Service**: Web3forms for sending emails from the contact form
- **Deployment**: Host the website on platforms like GitHub Pages, Netlify, or Vercel

## Contributing

Contributions are welcome! If you would like to contribute to the Portfolio Website, please fork the repository and submit a pull request with your proposed changes.

## Contact

For any inquiries or feedback, please contact [Deepak Ku. Mahanta](https://www.linkedin.com/in/contactdeepk/).

---

*Note: Replace placeholders (such as `yourusername`, `Your Name`, `[email protected]`, etc.) with appropriate values.*

0 comments on commit 8a36973

Please sign in to comment.