From dbb8a8e9196ecdbb32f980e3fd9987cfe0889380 Mon Sep 17 00:00:00 2001 From: tuanvu Date: Thu, 2 Jan 2025 00:12:53 +0100 Subject: [PATCH] readme --- README.md | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2e83873..30cdfc5 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,31 @@ -# Pokedemo +## Description +This is a project for 4rd year academic of Université de Rennes 1. -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.8. +--- -## Development server +## Disclaimer +> For the pokedemo it's in the main branch. The test is in tp_test branch +> We don't write all the test for cypress and Jest because it's a little bit too long. But we covered some major test. +> For Jest, we have some issue with pokeAPI so we try to mock but didnt work +> For the cypress it worked fine but we dont have many tests. -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. +--- -## Code scaffolding +## Prerequisits +Before cloning/forking this project, make sure the following tools are installed: -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. +- [npm] `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash` +- [nodejs] `nvm install 22` -## Build +## Installation +* Install npm and nodejs +* Uninstall karma jasmin `npm uninstall karma karma-chrome-launcher karma-coverage karma-jasmine karma-jasmine-html-reporter @types/jasmine jasmine-core` +* Install jest `npm i --save-dev jest @types/jest jest-preset-angular` +* Install cypress `npm run cypress` -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. +## Contributors +[//]: contributor-faces -## Running unit tests + -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). - -## Running end-to-end tests - -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. - -## Further help - -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. +