echecsfrance/README.md

<h1 style="text-align: center">Echecs France</h1>

[![fr](https://img.shields.io/badge/lang-fr-blue.svg?style=for-the-badge)](https://github.com/TheRealOwenRees/echecsfrance/blob/main/README-fr.md)

![GitHub](https://img.shields.io/github/license/therealowenrees/echecsfrance?style=for-the-badge)
![Vercel](https://vercelbadge.vercel.app/api/therealowenrees/echecsfrance?style=for-the-badge)
![Depfu](https://img.shields.io/depfu/dependencies/github/TheRealOwenRees/echecsfrance?style=for-the-badge)

## A website displaying upcoming chess tournaments for the [FFE](http://www.echecs.asso.fr/) on a map

## Tech Stack

This website is built in Typescript using:

- [Next.js](https://nextjs.org/)
- [Tailwind](https://tailwindcss.com/)
- [MongoDB](https://www.mongodb.com/)

and is deployed on [Vercel](https://vercel.com/)

## Dependencies

- [Leaflet](https://leafletjs.com/) - a Javascript library for interactive maps
- [Nodemailer](https://nodemailer.com/) - a module for Node.js applications to allow easy as cake email sending

## Required VSCode plugins

- ESLint
- Prettier - Code formatter

## Recommended VSCode plugins

- Tailwind CSS IntelliSense
- Tailwind Docs
- Code Spell Checker (to avoid English spelling mistakes in the code)
- Console Ninja (for easier debugging)

## Contributions

Contributions are encouraged. Please open an issue to discuss your ideas.

We use the [GitHub Flow](https://www.gitkraken.com/learn/git/best-practices/git-branch-strategy#github-flow-considerations) branching strategy. Add your code into a feature branch such as `feature/feature-name`.