README.md

Quota Shahid 2024

This project is a tribute to the students who lost their lives or were injured due to the actions of the fascist government in Bangladesh. We aim to remember and honor their sacrifice through this website. The project is built with Next.js, TypeScript, TailwindCSS, and ShadcnUI.

Table of Contents

• Getting Started
• Project Structure
• Contributing
• License
• Acknowledgements

Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js (>= 14.x)
• npm (>= 6.x) or yarn (>= 1.x)
• Git

Installation

1. Clone the repository:

   ```bash git clone https://github.com/Hamid-ul-Islam/quotashahid2024.git cd quotashahid2024 ```

2. Install dependencies:

   ```bash

   Using npm

   npm install

   Using yarn

   yarn install ```

3. Run the development server:

   ```bash

   Using npm

   npm run dev

   Using yarn

   yarn dev ```

   Open http://localhost:3000 in your browser to see the application.

Building for Production

To create an optimized production build:

```bash

Using npm

npm run build

Using yarn

yarn build ```

Project Structure

```plaintext . ├── public │ ├── images │ └── ... │ ├── components │ ├── components └──Ui │ ├── app │ │ ├── api │ │ └── ... │ ├── styles │ ├── types │ ├── utils │ └── ... ├── .gitignore ├── next.config.js ├── package.json ├── README.md └── tsconfig.json ```

• `public/` - Static assets such as images, fonts, etc.
• `components/` - React components.
• `components/` - React components.
• `app/` - Next.js app.
• `styles/` - TailwindCSS and other styles.
• `types/` - TypeScript types.
• `utils/` - Utility functions.

Contributing

We welcome contributions from the community to improve this project. Here's how you can get started:

1. Fork the repository:

   Click the "Fork" button at the top right of this page.

2. Clone your forked repository:

   ```bash git clone https://github.com/Hamid-ul-Islam/quotashahid2024.git cd quotashahid2024 ```

3. Create a new branch:

   ```bash git checkout -b feature/your-feature-name ```

4. Make your changes and commit them:

   ```bash git commit -m "Add some feature" ```

5. Push to the branch:

   ```bash git push origin feature/your-feature-name ```

6. Open a pull request:

   Go to the repository on GitHub and open a pull request.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you are expected to adhere to this code.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

This project is dedicated to the memory of the "Shahid" who sacrificed their lives. We honor their courage and commitment.