86 lines
2.7 KiB
Markdown
86 lines
2.7 KiB
Markdown
# Pixelbrew Website
|
|
|
|
Welcome to the Pixelbrew website project! This project is designed to showcase our web development services and provide a modern, responsive experience for our users.
|
|
|
|
## Table of Contents
|
|
|
|
- [Getting Started](#getting-started)
|
|
- [Project Structure](#project-structure)
|
|
- [Technologies Used](#technologies-used)
|
|
- [Features](#features)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
|
|
## Getting Started
|
|
|
|
To get started with the Pixelbrew website, follow these steps:
|
|
|
|
1. Clone the repository:
|
|
```
|
|
git clone https://github.com/yourusername/pixelbrew-website.git
|
|
```
|
|
2. Navigate to the project directory:
|
|
```
|
|
cd pixelbrew-website
|
|
```
|
|
3. Install the dependencies:
|
|
```
|
|
npm install
|
|
```
|
|
4. Run the development server:
|
|
```
|
|
npm run dev
|
|
```
|
|
5. Open your browser and visit `http://localhost:3000` to see the website in action.
|
|
|
|
## Project Structure
|
|
|
|
The project is organized as follows:
|
|
|
|
```
|
|
pixelbrew-website
|
|
├── public # Static assets
|
|
│ ├── favicon.ico # Favicon for the website
|
|
│ └── assets
|
|
│ └── images # Images used throughout the website
|
|
├── src # Source code
|
|
│ ├── components # Reusable components
|
|
│ ├── pages # Page components
|
|
│ ├── styles # CSS styles
|
|
│ ├── utils # Utility functions
|
|
│ └── types # TypeScript types
|
|
├── next.config.js # Next.js configuration
|
|
├── package.json # Project metadata and dependencies
|
|
├── postcss.config.js # PostCSS configuration
|
|
├── tailwind.config.js # Tailwind CSS configuration
|
|
├── tsconfig.json # TypeScript configuration
|
|
└── README.md # Project documentation
|
|
```
|
|
|
|
## Technologies Used
|
|
|
|
- **Next.js**: A React framework for server-side rendering and static site generation.
|
|
- **Tailwind CSS**: A utility-first CSS framework for styling.
|
|
- **TypeScript**: A superset of JavaScript that adds static types.
|
|
- **Framer Motion**: A library for animations in React.
|
|
|
|
## Features
|
|
|
|
- Modern, responsive design with a minimalist aesthetic.
|
|
- Multiple pages including Home, About Us, Services, Projects, and Contact.
|
|
- Reusable components for buttons and cards.
|
|
- Contact form with API integration.
|
|
- Social media links in the footer.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions to the Pixelbrew website! Please follow these steps:
|
|
|
|
1. Fork the repository.
|
|
2. Create a new branch for your feature or bug fix.
|
|
3. Make your changes and commit them.
|
|
4. Push your branch and create a pull request.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the LICENSE file for more details. |