final-space-api icon indicating copy to clipboard operation
final-space-api copied to clipboard

Published 20 hours ago • verified publisher icon lelouchB

Add Examples to the Documentation

Open lelouchB opened this issue 3 years ago • 17 comments

There is only one example present right now in the documentation i.e. Live React Example which can be found here https://finalspaceapi.com/docs/react/

Docusarus uses React Live for the interactive coder so it will only support React.

Add more example with the language and frameworks of your choice.

Resource: https://v2.docusaurus.io/docs/markdown-features/#syntax-highlighting

https://v2.docusaurus.io/docs/markdown-features/#interactive-code-editor

P.S. it doesn't necessarily have to be a live example. You can add simple code snippets with their output too.

Here are a few ideas for this

Completed

  • [x] Vue @bobluppes
  • [x] Angular @guzbarraf
  • [x] Vanilla JS @PSmigielski
  • [x] Vue+Axios @Devdre1909
  • [x] React + Axios @fernandoamz
  • [x] Svelte+ Axios @fullstackmafia

Rest is up to your imagination.

lelouchB avatar Oct 06 '20 17:10 lelouchB

@lelouchB, May I add an example with react + axios ?

fernandoamz avatar Oct 06 '20 17:10 fernandoamz

@lelouchB, May I add an example with Vainilla too? and with Ajax?

fernandoamz avatar Oct 06 '20 17:10 fernandoamz

Hey @fernandoamz Lets do one at a time, I am assigning you for React + Axios

After you are done with, if other are available I will assign it you Thanks

Looking forward to your contributions.

lelouchB avatar Oct 06 '20 17:10 lelouchB

👋 Hey @lelouchB, I am new on docusaurus, May you share me an example as to how to add an import into the theme-live-codeblock? I searched information but I couldn't resolve it. Thanks.

I have an error on the Result because I am not importing Axios Screen Shot 2020-10-06 at 3 56 57 PM

fernandoamz avatar Oct 06 '20 20:10 fernandoamz

Hey , @fernandoamz Sorry for the late response I see that you have figured this issue out. Great 👍

lelouchB avatar Oct 07 '20 02:10 lelouchB

Hey @lelouchB, could I make an example in Vue.js? Would very much like to try out your API at the same time ;)

bobluppes avatar Oct 07 '20 22:10 bobluppes

@bobluppes Ofcourse I will assign this issue to you as well.

lelouchB avatar Oct 08 '20 05:10 lelouchB

@bobluppes If you could use the episode endpoint in the example.

https://finalspaceapi.com/docs/episode

lelouchB avatar Oct 08 '20 13:10 lelouchB

Oh cool, is the endpoint finished now. Will definitely use it then. Expect a PR this evening or tomorrow morning

bobluppes avatar Oct 08 '20 13:10 bobluppes

Could i make vanilla JS and axios examples ?

PSmigielski avatar Oct 09 '20 08:10 PSmigielski

Could i make vanilla JS and axios examples ?

Sure @PSmigielski

lelouchB avatar Oct 09 '20 09:10 lelouchB

Hi @lelouchB, can I make Vue and Axios Examples?

Devdre1909 avatar Oct 12 '20 12:10 Devdre1909

@Devdre1909 yeah Sure, As you already know this will be static example. Be as creative as you can.

Use location endpoint and add screenshot of the Output too.

lelouchB avatar Oct 12 '20 12:10 lelouchB

Hi @lelouchB, give me the example in angular

guzbarraf avatar Oct 28 '20 04:10 guzbarraf

Awesome Thanks @guzbarraf

lelouchB avatar Oct 28 '20 04:10 lelouchB

Hi @lelouchB - I took a look at this and I think it's awesome. Could I make an example with SvelteJS and Axios?

fullstackmafia avatar Dec 30 '20 18:12 fullstackmafia

Hi @lelouchB - I took a look at this and I think it's awesome. Could I make an example with SvelteJS and Axios?

@fullstackmafia Sure, Go for It! Let me know if you have any questions.

lelouchB avatar Dec 31 '20 04:12 lelouchB