owenrees/echecsfrance
1
0
Fork 0
mirror of https://github.com/TheRealOwenRees/echecsfrance.git synced 2026-07-23 04:26:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

english about section

Browse Source
This commit is contained in:
Owen Rees
2023-06-27 22:43:55 +02:00
parent c379d341dc
commit 7e61931fdb
17 changed files with 132 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/cypress.yml
+1 -1
View File
@@ -17,7 +17,7 @@ jobs:
- name: Cache npm and NextJs build - name: Cache npm and NextJs build
uses: actions/cache@v3 uses: actions/cache@v3
with: with:
# See here for caching with `yarn` https://github.com/actions/cache/blob/main/examples#node---yarn or you can leverage caching with actions/setup-node https://github.com/actions/setup-node # See here for caching with `yarn` https://github.com/actions/cache/blob/main/examples#node---yarn, or you can leverage caching with actions/setup-node https://github.com/actions/setup-node
path: | path: |
~/.npm ~/.npm
${{ github.workspace }}/.next/cache ${{ github.workspace }}/.next/cache
README-fr.md
+1 -1
View File
@@ -1,4 +1,4 @@
<h1 align="center">Echecs France</h1> <h1 style="text-align: center">Echecs France</h1>
[![en](https://img.shields.io/badge/lang-en-blue.svg?style=for-the-badge)](https://github.com/TheRealOwenRees/echecsfrance/blob/main/README.md) [![en](https://img.shields.io/badge/lang-en-blue.svg?style=for-the-badge)](https://github.com/TheRealOwenRees/echecsfrance/blob/main/README.md)
README.md
+3 -3
View File
@@ -1,4 +1,4 @@
<h1 align="center">Echecs France</h1> <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) [![fr](https://img.shields.io/badge/lang-fr-blue.svg?style=for-the-badge)](https://github.com/TheRealOwenRees/echecsfrance/blob/main/README-fr.md)
@@ -20,11 +20,11 @@ and is deployed on [Vercel](https://vercel.com/)
## Dependencies ## Dependencies
- [Leaflet](https://leafletjs.com/) - a Javascript library for interactive maps - [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 - [Nodemailer](https://nodemailer.com/) - a module for Node.js applications to allow easy as cake email sending
## Contributions ## Contributions
Contributions are encouraged. Please open an issue to discuss your ideas. 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. 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. Please see the [TODO](https://github.com/TheRealOwenRees/echecsfrance/blob/main/TODO) file for a list of suggestions.
TODO
-1
View File
@@ -14,7 +14,6 @@ PAGES
---------------------------------------------------------------- ----------------------------------------------------------------
DESIGN CHANGES DESIGN CHANGES
//TODO success and error messages into french - mailer
//TODO font size on mobile screen //TODO font size on mobile screen
//TODO mobile navbar is creeping into the page by a few pixels when hidden - move it to the right a bit. It is easier to see in light mode. I cant see this on Linux //TODO mobile navbar is creeping into the page by a few pixels when hidden - move it to the right a bit. It is easier to see in light mode. I cant see this on Linux
//TODO logo for navbar and favicon //TODO logo for navbar and favicon
app/layout.tsx
+2 -5
View File
@@ -2,6 +2,7 @@ import { Analytics } from "@vercel/analytics/react";
import "./globals.css"; import "./globals.css";
import { Inter } from "next/font/google"; import { Inter } from "next/font/google";
import { ReactNode } from "react";
const inter = Inter({ subsets: ["latin"] }); const inter = Inter({ subsets: ["latin"] });
@@ -11,11 +12,7 @@ export const metadata = {
keywords: "echecs, France, tournoi, tournois, FFE, carte", keywords: "echecs, France, tournoi, tournois, FFE, carte",
}; };
export default function RootLayout({ export default function RootLayout({ children }: { children: ReactNode }) {
children,
}: {
children: React.ReactNode;
}) {
return ( return (
<html lang="en"> <html lang="en">
<body className={inter.className}> <body className={inter.className}>
app/page.tsx
+3
View File
@@ -1,9 +1,12 @@
// noinspection HttpUrlsUsage,HtmlUnknownTarget
import Link from "next/link"; import Link from "next/link";
import Image from "next/image"; import Image from "next/image";
import Layout from "@/components/Layout"; import Layout from "@/components/Layout";
import bgImage from "@/public/images/map-bg.jpg"; import bgImage from "@/public/images/map-bg.jpg";
export default function Home() { export default function Home() {
// noinspection HtmlUnknownTarget
return ( return (
<Layout> <Layout>
<header className="grid h-[calc(100%-153px)] md:h-[calc(100%-173px)] place-items-center"> <header className="grid h-[calc(100%-153px)] md:h-[calc(100%-173px)] place-items-center">
app/qui-sommes-nous/page.tsx
+96 -3
View File
@@ -1,11 +1,11 @@
import Link from "next/link";
import Layout from "@/components/Layout"; import Layout from "@/components/Layout";
export default function About() { export default function About() {
return ( return (
<Layout> <Layout>
<header className="grid h-[calc(100%-216px)] md:h-[calc(100%-174px)] place-items-center"> <header className="grid h-[calc(100%-216px)] md:h-[calc(100%-174px)] place-items-center">
<div className="relative h-full w-full bg-white dark:bg-gray-800"></div> <div className="h-full px-4 pt-8 pb-12 bg-white dark:bg-gray-800">
<div className="absolute">
<h2 <h2
className="mb-4 text-4xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white" className="mb-4 text-4xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white"
data-test="header2" data-test="header2"
@@ -13,8 +13,101 @@ export default function About() {
Qui Sommes-Nous? Qui Sommes-Nous?
</h2> </h2>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl"> <p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
Prochainement This project was first started in early 2022 as a means to visualise
where chess tournaments were taking place in France. Having moved to
France in 2019, I did not know my way around the country and wanted
to know which tournaments were happening near me.
</p> </p>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
The project was shelved until Spring 2023 when it was given a new
lease of life. Rebuilt from the ground up,{" "}
<Link href="/" className="text-teal-600">
Echecs France
</Link>{" "}
is now open source and open to contributions.
</p>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
I will be setting up a donation link if you wish to help cover some
of the costs of running this website. After costs, and remaining
funds will put back into the chess community by means of sponsoring
events or by donations.
</p>
<h3
className="mb-4 text-2xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white"
data-test="header2"
>
Credits
</h3>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
This project is what it is thanks to the contributions of the wider
community. In particular I would like to thank the following for
their contributions so far:
<ul>
<li>Alvaro</li>
<li>Flo</li>
</ul>
</p>
<h3
className="mb-4 text-2xl tracking-tight font-extrabold text-center text-gray-900 dark:text-white"
data-test="header2"
>
Tech Blurb
</h3>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
<Link href="/" className="text-teal-600">
Echecs France
</Link>{" "}
is built on the following tech stack:
<ul className="flex justify-around text-teal-600">
<li>
<Link href="https://nextjs.org/" target="_blank">
NextJS
</Link>
</li>
<li>
<Link href="#" target="_blank">
Typescript
</Link>
</li>
<li>
<Link href="https://tailwindcss.com/" target="_blank">
Tailwind
</Link>
</li>
<li>
<Link href="https://mongodb.com/" target="_blank">
MongoDB
</Link>
</li>
</ul>
</p>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
with the following core dependencies:
<ul className="flex justify-around text-teal-600">
<li>
<Link href="https://leafletjs.com/" target="_blank">
Leaflet
</Link>
</li>
<li>
<Link href="https://nodemailer.com/" target="_blank">
Nodemailer
</Link>
</li>
</ul>
</p>
<p className="mb-8 lg:mb-16 font-light text-center text-gray-500 dark:text-gray-400 sm:text-xl">
For more information and details on how to contribute, please visit
our{" "}
<Link
href="https://github.com/TheRealOwenRees/echecsfrance"
target="_blank"
className="text-teal-600"
>
GitHub repository
</Link>
</p>
.
</div> </div>
</header> </header>
</Layout> </Layout>
components/Footer.tsx
+1 -1
View File
@@ -4,7 +4,7 @@ import { FaGithub, FaRegEnvelope } from "react-icons/fa";
export default function Footer() { export default function Footer() {
return ( return (
<footer <footer
className="grid w-full fixed bottom-0 justify-items-center py-2 px-5 text-white bg-teal-600 text-gray-900 dark:bg-gray-700 z-30" className="grid w-full fixed bottom-0 justify-items-center py-2 px-5 text-white bg-teal-600 dark:bg-gray-700 z-30"
data-test="footer" data-test="footer"
> >
<div className="p-2"> <div className="p-2">
components/HamburgerMenu.tsx
+3
View File
@@ -1,3 +1,5 @@
// noinspection HtmlUnknownTarget
interface HamburgerMenuState { interface HamburgerMenuState {
menuVisible: boolean; menuVisible: boolean;
setMenuVisible: Dispatch<SetStateAction<boolean>>; setMenuVisible: Dispatch<SetStateAction<boolean>>;
@@ -46,6 +48,7 @@ const HamburgerMenu = ({
menuTimeout, menuTimeout,
}); });
// noinspection HtmlUnknownTarget
return ( return (
<div <div
ref={menuRef} ref={menuRef}
components/Layout.tsx
+2 -1
View File
@@ -1,10 +1,11 @@
import Navbar from "@/components/Navbar"; import Navbar from "@/components/Navbar";
import Footer from "@/components/Footer"; import Footer from "@/components/Footer";
import { ReactNode } from "react";
export default function Layout({ export default function Layout({
children, // will be a page or nested layout children, // will be a page or nested layout
}: { }: {
children: React.ReactNode; children: ReactNode;
}) { }) {
return ( return (
<div className="h-screen min-h-[600px] bg-white dark:bg-gray-800 font-sans leading-normal tracking-normal"> <div className="h-screen min-h-[600px] bg-white dark:bg-gray-800 font-sans leading-normal tracking-normal">
components/TournamentMap.tsx
+2
View File
@@ -1,3 +1,5 @@
// noinspection HttpUrlsUsage
"use client"; "use client";
import { TournamentDataProps } from "@/types"; import { TournamentDataProps } from "@/types";
cypress.config.ts
+2
View File
@@ -1,3 +1,5 @@
// noinspection JSUnusedGlobalSymbols
import { defineConfig } from "cypress"; import { defineConfig } from "cypress";
export default defineConfig({ export default defineConfig({
cypress/e2e/links.cy.ts
+2
View File
@@ -1,3 +1,5 @@
// noinspection HttpUrlsUsage
describe("Test links", () => { describe("Test links", () => {
const pages = ["tournois", "qui sommes-nous", "contactez-nous"]; const pages = ["tournois", "qui sommes-nous", "contactez-nous"];
cypress/support/commands.ts
+2
View File
@@ -1,3 +1,5 @@
// noinspection JSUnusedGlobalSymbols
declare namespace Cypress { declare namespace Cypress {
interface Chainable { interface Chainable {
getByData(dataTestAttribute: string): Chainable<JQuery<HTMLElement>>; getByData(dataTestAttribute: string): Chainable<JQuery<HTMLElement>>;
cypress/support/component-index.html
+2
View File
@@ -1,4 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<!--suppress HtmlRequiredLangAttribute, HtmlUnknownTag -->
lUnknownTag -->
<html> <html>
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
cypress/support/component.ts
+5 -4
View File
@@ -14,12 +14,12 @@
// *********************************************************** // ***********************************************************
// Import commands.js using ES2015 syntax: // Import commands.js using ES2015 syntax:
import './commands' import "./commands";
// Alternatively you can use CommonJS syntax: // Alternatively you can use CommonJS syntax:
// require('./commands') // require('./commands')
import { mount } from 'cypress/react18' import { mount } from "cypress/react18";
// Augment the Cypress namespace to include type definitions for // Augment the Cypress namespace to include type definitions for
// your custom command. // your custom command.
@@ -27,13 +27,14 @@ import { mount } from 'cypress/react18'
// with a <reference path="./component" /> at the top of your spec. // with a <reference path="./component" /> at the top of your spec.
declare global { declare global {
namespace Cypress { namespace Cypress {
// noinspection JSUnusedGlobalSymbols
interface Chainable { interface Chainable {
mount: typeof mount mount: typeof mount;
} }
} }
} }
Cypress.Commands.add('mount', mount) Cypress.Commands.add("mount", mount);
// Example use: // Example use:
// cy.mount(<MyComponent />) // cy.mount(<MyComponent />)
lib/sendMail.ts
+1 -2
View File
@@ -9,14 +9,13 @@ const sendMail = async ({
message: message, message: message,
}; };
const response = await fetch("/api/send-mail", { return await fetch("/api/send-mail", {
method: "POST", method: "POST",
headers: { headers: {
"Content-Type": "application/json", "Content-Type": "application/json",
}, },
body: JSON.stringify(data), body: JSON.stringify(data),
}); });
return response;
}; };
export default sendMail; export default sendMail;