Bot-Rakshit / bm_frontend

Frontend repository of Samay Raina's chess community website
https://www.bmsamay.com/
MIT License
96 stars 55 forks source link
chess chesscom chesscom-api samay samayraina

BMSamay.com Frontend

Join our Discord - https://discord.gg/6Pje7Wch

All Contributors

License

This is Samay Raina's official community website for chess enthusiasts. Support the Developer - "Buy Me A Coffee"

šŸ“‘ Table of Contents

šŸŽ‰ Features

āš™ļø Prerequisites

Make sure you have the following installed on your development machine:

šŸš€ Getting Started

Follow these steps to get started with the BMSamay.com Frontend:

  1. Clone the repository:

    git clone https://github.com/Bot-Rakshit/bm_frontend.git
  2. Navigate to the project directory:

    cd bm_frontend
  3. Install the dependencies:

    pnpm install

    or

    npm install
  4. Start the development server:

    pnpm dev
    npm run dev

šŸ“œ Available Scripts

šŸ“‚ Project Structure

The project structure follows a standard React application layout:

bm_frontend/
  ā”œā”€ā”€ node_modules/      # Project dependencies
  ā”œā”€ā”€ public/            # Public assets
  ā”œā”€ā”€ src/               # Application source code
  ā”‚   ā”œā”€ā”€ components/    # React components
  ā”‚   ā”‚   ā””ā”€ā”€ ui/        # shadc/ui components
  ā”‚   ā”œā”€ā”€ styles/        # CSS stylesheets
  ā”‚   ā”œā”€ā”€ lib/           # Utility functions
  ā”‚   ā”œā”€ā”€ App.tsx        # Application entry point
  ā”‚   ā””ā”€ā”€ index.tsx      # Main rendering file
  ā”œā”€ā”€ .eslintrc.json     # ESLint configuration
  ā”œā”€ā”€ index.html         # HTML entry point
  ā”œā”€ā”€ postcss.config.js  # PostCSS configuration
  ā”œā”€ā”€ tailwind.config.js # Tailwind CSS configuration
  ā”œā”€ā”€ tsconfig.json      # TypeScript configuration
  ā””ā”€ā”€ vite.config.ts     # Vite configuration

šŸ¤ Contribution

We welcome contributions to the BMSamay.com Frontend project! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a pull request.

Please read our Contributing Guidelines for more details.

šŸ“„ License

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

Contributors āœØ

Thanks goes to these wonderful people (emoji key):

Rakshit Singh
Rakshit Singh

šŸ’» šŸš§
DG
DG

šŸ’»
Karthik Sunil
Karthik Sunil

šŸ’»
Vishant Shah
Vishant Shah

šŸ’»
Hemant Pradeep Modi
Hemant Pradeep Modi

šŸ’»
Moutasim
Moutasim

šŸ’»
Nilesh Gosavi
Nilesh Gosavi

šŸ’»
Manjot Singh
Manjot Singh

šŸ’» šŸš§
n0step_
n0step_

šŸ’»
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!