Skip to content

Commit

Permalink
doc: add doc to help contributor, part musician announces
Browse files Browse the repository at this point in the history
  • Loading branch information
Cryde committed May 26, 2024
1 parent 8e04ae5 commit 5360449
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ npm run build

You can now access http://musicall.localhost

[Learn how to use the application](doc/index.MD).

## TODO

- [ ] Create fixtures
Expand Down
43 changes: 43 additions & 0 deletions doc/howto-musician-announce.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# How to use the Musician Announce

The announces are separated in 3 parts : the management, the search & the display of last announces in the homepage.

## Announce management

The user can manage it's own announces : list & create them.
_Note: right now it not possible to edit or remove announce_

To access the list you have to be logged in.
Then you click on your profile menu (top right) and then click on "Mes annonces" :

![Access to the announces list](musician-announce/profile-announce-access.png)

Once the there you will see a list of your announces :

![The announces list](musician-announce/announce-list.png)


From there you create a new one by clicking on "Ajouter une nouvelle annonce"
This will open a modal that will guide you to create an announce.

For this particular part here are the interesting endpoints :
- `api_instruments_get_collection` to get the list of instruments
- `api_styles_get_collection` to get the list of music styles
- `api_musician_announces_post` to create a new announce
- `api_musician_announces_get_self_collection` to get the user own announces

## Last announces in the homepage

Visitor can see last announce the other user have created.
This part is available in the homepage :
![Last announce](musician-announce/last-announce-homepage.png)

You will note that there is buttons to create an announce (we have seen that in the previous point) and search for an announce.

For this particular part here are the interesting endpoints :
- `api_musician_announces_get_last_collection` to get the last added musician announces


## Search

Todo
11 changes: 11 additions & 0 deletions doc/index.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How to use MusicAll

This documentation will explain you how to use and where to search if you want to contribute to MusicAll.
It will be split by "sections" related to the website.
You should have MusicAll up and running as requirement (of course you can read this just for fun!)


- [How to use the musician announce](howto-musician-announce.MD)


_Note: this is an in progress doc, more to come_
Binary file added doc/musician-announce/announce-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/musician-announce/last-announce-homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/musician-announce/profile-announce-access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5360449

Please sign in to comment.