echecsfrance/README.md

<h1 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)
[![Echecs France](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/1nghs5&style=for-the-badge&logo=cypress)](https://cloud.cypress.io/projects/1nghs5/runs)

## 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/)
- [Cypress](https://www.cypress.io/) 

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

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

## Contributions
Contributions are encouraged. Please open an issue to discuss your ideas.  
Add your code into a feature branch such as `feature/feature-name`. We utilise a [Github Flow](https://www.gitkraken.com/learn/git/best-practices/git-branch-strategy#github-flow-considerations) branching strategy. 


Please see the [TODO](https://github.com/TheRealOwenRees/echecsfrance/blob/main/TODO) file for a list of suggestions.