Skip to content

Latest commit

 

History

History
167 lines (124 loc) · 8.3 KB

README.md

File metadata and controls

167 lines (124 loc) · 8.3 KB

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!