Merge pull request #8 from RaphaelEscrig/refactor/clean-code

Clean code and add utils tests

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Raphaël Escrig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,36 +1,31 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# ECN speci rank
 
-## Getting Started
+> 🩺 A web app to determine which specialty you would have had based on your ECN ranking (from 2019 to 2023).
 
-First, run the development server:
+[![version](https://img.shields.io/github/v/release/RaphaelEscrig/ecn-speci-rank?style=for-the-badge&logo=github)](https://github.com/RaphaelEscrig/ecn-speci-rank/releases)
+[![license](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://github.com/RaphaelEscrig/ecn-speci-rank/blob/main/LICENSE)
+![typeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Purpose
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+🚀 This web app is designed to help users determine their potential medical specialty based on their ECN ranking. It provides the following functionalities:
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+- Specialty Determination: See which specialties are available based on your ECN ranking.
+- City Availability: View which cities offer your preferred specialties according to your ranking.
+- Internship Listings: Access a comprehensive listing of all interns taken by specialty.
 
-## Learn More
+This tool is aimed at medical students and professionals who want to explore their options and make informed decisions regarding their specialty and location preferences based on historical data (from 2019 to 2023).
+All data is taken from the official journal [Légifrance](https://www.legifrance.gouv.fr/).
 
-To learn more about Next.js, take a look at the following resources:
+## Use
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+### Launch
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+Run the server with the following command line.
 
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+```sh
+pnpm install && pnpm dev
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Then open [http://localhost:3000](http://localhost:3000) to launch the Web App.

src/app/globals.scss

@@ -15,10 +15,8 @@
 html,
 body {
 	max-width: 100vw;
-	// max-height: 100vh;
 	min-height: 100vh;
 	height: 100%;
-	/* overflow-x: hidden; */
 }
 
 main {

src/app/locales/i18n.ts

@@ -2,10 +2,7 @@
 import { getRequestConfig } from "next-intl/server";
 
 export default getRequestConfig(async () => {
-	// Provide a static locale, fetch a user setting,
-	// read from `cookies()`, `headers()`, etc.
 	const locale = "fr";
-
 	const modules = ["cities", "specialties", "shared"];
 
 	const modulesMessages = await Promise.all(

src/modules/app/main.ts

@@ -1,9 +1,9 @@
 /** ADAPTERS */
 import postgres from "postgres";
-import { InMemoryCitiesGateway } from "../cities/core/infrastructure/in-memory/in-memory-cities.gateway";
-import { InMemorySpecialtiesGateway } from "../specialties/core/infrastructure/in-memory/in-memory-specialties.gateway";
-import { PSQLSpecialtiesGateway } from "../specialties/core/infrastructure/psql/psql-specialties.gateway";
-import { PSQLCitiesGateway } from "../cities/core/infrastructure/psql/psql-cities.gateway";
+import { InMemoryCitiesGateway } from "@/modules/cities/core/infrastructure/in-memory/in-memory-cities.gateway";
+import { InMemorySpecialtiesGateway } from "@/modules/specialties/core/infrastructure/in-memory/in-memory-specialties.gateway";
+import { PSQLSpecialtiesGateway } from "@/modules/specialties/core/infrastructure/psql/psql-specialties.gateway";
+import { PSQLCitiesGateway } from "@/modules/cities/core/infrastructure/psql/psql-cities.gateway";
 /** MODELS */
 import type { Dependencies } from "@/modules/shared/domain/models";