Skip to content

Bot-Rakshit/bm_frontend

Repository files navigation

BMSamay.com Frontend

Not actively maintained. We are shifting the codebase to v2.

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

  • Community Dashboard - An interactive dashboard which shows the chess community stats and leaderboard.
  • Chess News - Chess news from all over the world powered by ChessBase India.
  • Connect Your Chess.com Profile - Connect your chess.com profile to see where you stand in the community leaderboard.
  • BM Points - A point based scoring for correct guesses of samay's chess games.
  • Integrations - Coming soon.
  • Streamers - Coming soon.

โš™๏ธ Prerequisites

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

  • Node.js (version 16 or above) - preferred v22.x.x
  • pnpm (package manager) or npm - preferred pnpm

๐Ÿš€ 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

  • pnpm dev - Starts the development server.
  • pnpm build - Builds the production-ready code.
  • pnpm lint - Runs ESLint to analyze and lint the code.
  • pnpm preview - Starts the Vite development server in preview mode.

๐Ÿ“‚ 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!

About

Frontend repository of Samay Raina's chess community website

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 23