|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
| 1 | +# Bennett Taylor's Portfolio |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +Welcome to the personal portfolio website of Bennett Taylor, an Electrical and Computer Engineering (ECE) M.S. student at Boston University. This project is built using Next.js, Tailwind CSS, and React. |
| 4 | + |
| 5 | +## Project Structure |
4 | 6 |
|
5 | | -First, run the development server: |
| 7 | +The project is organized as follows: |
6 | 8 |
|
7 | | -```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | 9 | ``` |
| 10 | +bennett-taylor-portfolio |
| 11 | +├── src |
| 12 | +│ ├── app |
| 13 | +│ │ ├── page.js # Main entry point for the application |
| 14 | +│ │ ├── layout.js # Layout structure wrapping main content |
| 15 | +│ │ └── globals.css # Global CSS styles including Tailwind imports |
| 16 | +│ ├── components |
| 17 | +│ │ ├── Header.js # Navigation menu and branding |
| 18 | +│ │ ├── Footer.js # Copyright and social media links |
| 19 | +│ │ ├── About.js # Information about Bennett Taylor |
| 20 | +│ │ ├── Projects.js # List of projects |
| 21 | +│ │ └── Contact.js # Contact form or information |
| 22 | +│ └── data |
| 23 | +│ └── projects.js # Project data used in Projects component |
| 24 | +├── public |
| 25 | +│ └── favicon.ico # Favicon for the website |
| 26 | +├── tailwind.config.js # Tailwind CSS configuration |
| 27 | +├── postcss.config.js # PostCSS configuration |
| 28 | +├── package.json # npm configuration and dependencies |
| 29 | +├── README.md # Project documentation |
| 30 | +└── next.config.js # Next.js configuration |
| 31 | +``` |
| 32 | + |
| 33 | +## Features |
| 34 | + |
| 35 | +- **Responsive Design**: The website is designed to be fully responsive, ensuring a great user experience on all devices. |
| 36 | +- **Dynamic Components**: Utilizes React components for modularity and reusability. |
| 37 | +- **Tailwind CSS**: Leverages Tailwind CSS for styling, allowing for rapid UI development with utility-first classes. |
| 38 | +- **Project Showcase**: Displays a curated list of projects that Bennett has worked on, with detailed descriptions and links. |
| 39 | + |
| 40 | +## Getting Started |
16 | 41 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 42 | +To get started with this project, follow these steps: |
18 | 43 |
|
19 | | -You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file. |
| 44 | +1. Clone the repository: |
| 45 | + ``` |
| 46 | + git clone https://github.com/yourusername/bennett-taylor-portfolio.git |
| 47 | + ``` |
20 | 48 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 49 | +2. Navigate to the project directory: |
| 50 | + ``` |
| 51 | + cd bennett-taylor-portfolio |
| 52 | + ``` |
22 | 53 |
|
23 | | -## Learn More |
| 54 | +3. Install the dependencies: |
| 55 | + ``` |
| 56 | + npm install |
| 57 | + ``` |
24 | 58 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 59 | +4. Run the development server: |
| 60 | + ``` |
| 61 | + npm run dev |
| 62 | + ``` |
26 | 63 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 64 | +5. Open your browser and navigate to `http://localhost:3000` to view the portfolio. |
29 | 65 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 66 | +## Contributing |
31 | 67 |
|
32 | | -## Deploy on Vercel |
| 68 | +Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request. |
33 | 69 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 70 | +## License |
35 | 71 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 72 | +This project is licensed under the MIT License. See the LICENSE file for more details. |
0 commit comments