Skip to content

Commit

Permalink
doc: add additional notes
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrienGiboire committed Oct 14, 2021
1 parent c7862f8 commit 12038e9
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ Ce qu'il faut installer sur votre machine pour que ce projet tourne :

## Installer le projet

Il suffit de lancer la commande suivante pour que les dépendances du projet
soient installées :
Il suffit de lancer les commandes suivantes pour que les dépendances du projet
soient installées, et mettre en place la base de données :

```
bundle install
bin/rails db:migrate
```

## Lancer le projet

*Note* : Si vous n'avez pas l'intention de lancer la tâche Rake, vous pouvez
vous contenter de lancer le serveur.
Ce projet utilise Sidekiq, qui dépend de Redis. Donc avant de pouvoir faire
tourner l'ensemble du projet, il faut lancer ces deux services :

Expand All @@ -42,3 +45,9 @@ bin/rake pokemons:update
Cette tâche va aller chercher tous les pokemons disponibles sur PokeAPI et
mettre en file d'attente un job par pokemon. Pour voir l'avancée de la mise à
jour, vous pouvez donc consulter le dashboard de Sidekiq.

## TODO

- [] paginate pokemons index
- [] remove url attribute from pokemon in `pokemon/show/:id` because of the
redundancy

0 comments on commit 12038e9

Please sign in to comment.