I started on creating Gretting's workflow but didn't complete it.

It can be found here
https://github.com/lelouchB/final-space-api/blob/main/.github/workflows/greetings.yml

Complete this with some fun and comic quotes or references to the show, it all about your creativity.
Chookity! Chookity!

P.S. Encourage people to start this repo. :)

Following #95 and #97
Add documentation for location endpoint

You can take reference from episode and character endpoint documentation.

new functionality that returns creatures that are part of Final Space.

Add a GitHub star button on the landing page.

Here is how docusaurus do it. https://v2.docusaurus.io/

You can refer to their code here. https://github.com/facebook/docusaurus/blob/2e9854964d3ba7b79634de37d6971532e457a9b3/website/src/pages/index.js#L92

Make sure to add the accompanying css.

After random url its not showing 404 not found page,

Describe the bug
The frontend contributing section of the readme states to run npm run server. However, server is not recognized an an npm script.

To Reproduce
Steps to reproduce the behavior:

1. Navigate to '/frontend`
2. Run npm run build
3. Run npm run server

Expected behavior
The development server is expected to spawn on localhost:3000.

Desktop (please complete the following information):

• OS: Linux
• Browser N.A.

Additional context
Encountered on the CLI

When cloning a project locally, there is no data to start with for testing or experiment with, so it will be nice if there's a seeder to seed data to the local database.

I'm thinking of adding an npm script called seed so we will have command npm run seed to seed local database with current actual data fetched from api

so basically the npm run seed will:-

1. connect to local database
2. fetch data from api.
3. seed local database.

I think the file will be named seeder.js and it will be in the root of backend folder and use Axios as dev dependency

If you like the idea assign it to me so I'll give it a shot

Add a sort parameter which lets the user sort the response based on id.

https://finalspaceapi.com/api/v0/character/?sort=desc
Return the response starting from 40

https://finalspaceapi.com/api/v0/character/?sort=asc
This response will be same as https://finalspaceapi.com/api/v0/character/ i.e. from 1 to 40.

So, https://finalspaceapi.com/api/v0/character/ is the same as https://finalspaceapi.com/api/v0/character/?sort=asc and they both return same response.

Resource: http://expressjs.com/en/api.html#req.query

following #48

Mooncake image was used as PWA logo but that image has grayish background which doesn't look good.

Your mission should you choose to accept it
Take this Mooncake image or another similar from web

Generate icons here https://www.pwabuilder.com/imageGenerator

And update the existing logo under static/img/pwa
Make sure rhe background is transparent.

Pretty straightforward :)

There is no 404 page, so add one. #27

Head to https://finalspaceapi.com/404
Thanks @mahendrarathore1742 for this issue.

Error expected :

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

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

Rest is up to your imagination.

Currently all of the docs under frontend/docs are missing headers.

Add the required headers for better SEO.

Refer here https://v2.docusaurus.io/docs/markdown-features#markdown-headers

P.S. you can leave the image part.

Is your feature request related to a problem? Please describe.
Currently, all character and episode endpoints just return the character/episode json or an array of the character/episodes that match the request.

Describe the solution you'd like
I think that all correct responses should have one of the following formats:

{
  "status": 200,
  "data": {}
}

or

{
  "status": 200,
  "results": [],
}

Of course, the response status should match the correct status of the response. If we changed to doing this, though, then it would allow us to include errors in incorrect responses that doesn't look weird. For example, if I were getting data from a certain character, but I sent the request to /character/9999, we only get a 502 Bad Gateway message. We should, however, return the following data:

{
  "status": 404,
  "message": "The character you have requested was not found."
}

Edit: the message property could be swapped for error.

Using statuses instead of errors allows an easier debugging process, as the developer can access the message and status that the servers sent.

I will work on a PR if this is deemed as needed by the community.

What is this ./endpoint about ?
Final Space has some great fun quotes by its characters.
This endpoint will be sending quotes.

Maybe after initial setup add a filter that will send quotes from a specific character.

What is the schema ?

quote : 'Quote',
by : 'Name of character',
character : 'URL to that character endpoint',
image: 'URL to Character Image'

Reopened to include Season 3 Episodes

The /episode endpoint is currently in progress.
Contribute data for individual episodes of Final Space in the given schema.

Resource: https://final-space.fandom.com/wiki/Final_Space_Wiki

P.S. You can leave the field for img_url.

You can send a PR with the data in JSON format to the endpoint branch under episode folder.

Here is the schema for /episode endpoint:

• Indicates that the data exists for that episode.

Here is the complete list of episodes we need data for

• Chaper 1

• Chaper 2

• Chaper 3

• Chaper 4

• Chaper 5

• Chaper 6

• Chaper 7

• Chaper 8

• Chaper 9

• Chaper 10

• The Toro Regatta

• The Happy Place

• The Grand Surrender

• The Other Side

• The Notorious Mrs. Goodspeed

• The Arachnitects

• The First Times They Met

• The Remembered

• The Closer You Get

• The Lost Spy

• The Set Up

• The Descent Into Darkness

• The Sixth Key

@JuanVqz Did a great job adding husky and prettier to backend to format code when commiting.
See #112

   "husky": {
        "hooks": {
            "pre-commit": "lint-staged"
        }
    },
    "lint-staged": {
        "*.js": "eslint --cache --fix",
        "*.{js,css,md}": "prettier --write"
    }

Add same thing to frontend folder.

The /character endpoint currently has 25 40 characters. (Update #25 )

There are still few characters that we can add to this endpoint.

Contribute data for individual characters of Final Space in the given schema.

Resource: https://final-space.fandom.com/wiki/Category:Characters

P.S. You can leave the field for img_url.

You can send a PR with the data in JSON format to the endpoint branch under character folder.

Please check if the data for that character exists.

Here is the schema for /character endpoint:

Embed Weibenfalk video in Examples section

https://youtu.be/zmwG5lYQYRo

P.S. make sure to add links to his Twitter, website etc.

Is your feature request related to a problem? Please describe.
We should make it so that api endpoints/urls are not repeated in the back-end code at all. All of the endpoints should be pulled from an endpoints file that gives you all of the data to handle the requests.

Describe the solution you'd like
I already created an endpoints.js in a PR, all we have to do is include this within the api endpoint files.

Live Example on https://finalspaceapi.com/docs/react
is currently using data.slice(0,5) to limit the character cards..

Now that limit query is finished, update this example with the limit query.

Resource
https://finalspaceapi.com/docs/character#limit-the-response

Docusaurus has a very cool announcement bar:

Add something similiar to this to frontend.
Please don't copy it as it is, add some original text to engage the visitors like a small fun or comic quote.

Resource
https://v2.docusaurus.io/docs/theme-classic/#announcement-bar

Highlight important lines in the code snippets in Examples.

For example in the frontend/docs/react.mdx, you can highlight the useEffect() and axios fetching code lines.

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

P.S just highlight the few important lines like where data is fetched, used, etc.

Is your feature request related to a problem? Please describe.
The README lacks some important features related to contribution for beginners and some other features need to be added.

Describe the solution you'd like
Adding badges and writing a clear and concise guideline for contribution

Additional context
I would be adding some badges to give it a modern look and some other edits

Docusarus provides ideal image plugin. This plugin will optimize images in the production build.

https://v2.docusaurus.io/docs/using-plugins#docusaurusplugin-ideal-image

Add this plugin and update the images in the frontend folder, specifically the images on the landing page

Here is the permalink for the code that needs to be updated

Add this plugin and configure it with proper images and theme colors.

https://v2.docusaurus.io/docs/using-plugins#docusaurusplugin-pwa

Let me know if you have any questions.

Add this plugin

https://v2.docusaurus.io/docs/using-plugins#docusaurusplugin-google-analytics

P.S. you can leave the trackingId blank, I will fill it myself.

Relies on #2 i.e. after Tests have been written.

Here is a possible

name: Node.js CI

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: [8.x, 10.x, 12.x]

    steps:
    - uses: actions/checkout@v2
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v1
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm install
    - run: npm run build --if-present
    - run: npm test
      env:
        CI: true

Currently the introduction to the API is very small.

https://finalspaceapi.com/docs/

This is a documentation issue, write a good introduction ot the API.

Word Limit - 250 to 300 words. This is just a suggestion, even if you end up writing 500 words, just send the PR we will work something out.

Following #95 location endpoint will be live soon.

Create images for all the different locations present in #95

Images should be 300x300 jpeg

Add serve-favicon to backend/server.js

Reources: https://www.npmjs.com/package/serve-favicon

Add the LIMIT parameter to the character endpoint.
Users can limit the number of responses from the API

Something like this
https://finalspaceapi.com/api/v0/character?limit=4

This will result in first 4 characters in the Database

Resources
https://stackabuse.com/get-query-strings-and-parameters-in-express-js/
https://expressjs.com/en/resources/middleware.html
https://masteringjs.io/tutorials/express/req

Is your feature request related to a problem? Please describe.
Currently the images are stored in the local directory and are sent from the same.

Describe the solution you'd like
Migrate all the images to Cloudinary.

With Cloudinary, users will be able to resize, crop and transform images as per their app requirements.

Contirbute data to quote endpoint.

Make the PR to endpoint branch.

Following #78
The response from https://finalspaceapi.com/api/v0 has changed but the same has not been updated here
https://finalspaceapi.com/docs/

Update the output of the base endpoint.
https://github.com/lelouchB/final-space-api/blob/main/frontend/docs/intro.md

Image formats like JPEG 2000, JPEG XR, and WebP often provide better compression than PNG or JPEG, which means faster downloads and less data consumption.

Change the format of the following images to WebP.
(Note: this is only for the images under frontend/static/img which are displayed on the landing page.)

• Indicates that WebP format exists for that image.

• gary_goodspeed.jpg

• avocato.jpg

• kvn.jpg

• mooncake.jpg

• little_cato.jpg

• quinn_ergon.jpg

• ash_graven.jpg

Reopened to include Season 3 Episode Images

Epsiode endpoint is under construction #4 and #28

There are 23 images that need to be created, keep the size 640x360px

Following #91
Demonstrate with proper images and commands how to seed the local database.

Assigned to @mhalsubhi

Reopened to include Season 3 locations

The /location endpoint is currently in progress.

You can contribute data for locations in Final Space in the given schema.

Resource: https://final-space.fandom.com/wiki/Category:Location

P.S. You can leave the field for img_url.

You can send a PR with the data in JSON format to the endpoint branch under location folder.

Here is the schema for /location endpoint:

(leave fields with no information as Unknown or just empty.)

P.S.: The information about locations is less, so 5-10 main locations data is enough.

This may include but not limited to the following location.

• Indicates that the data exists for that episode.

• Earth

• Final Space

• Tera Con Prime

• Inner Space

• Yarno

• Dark Zone

• Deathcropolis

• Lazarus Trap

• The Order of the Twelve

The episode endpoint will be live soon..

Refer to #4 and #28 and #42

Follow this:
https://finalspaceapi.com/docs/character

Currently, this image is used as logo and favicon.

Create a new logo for this API

I would suggest becoming familiar with Final Space will be beneficial.
Even Mooncake can be used as a logo.

It's upto your imagination.

Describe the bug
I just followed all steps mentioned in the README for running the backend in development. After running npm run serve in the backend directory, though, localhost:8000 is not returning any data when sending a request to http://localhost:8000/api/v0/character or any of the other endpoints besides http://localhost:8000/api/v0/.

To Reproduce
Steps to reproduce the behavior:

1. gh repo clone lelouchB/final-space-api
2. cd final-space-api
3. cd backend
4. npm install
5. npm run dev
6. go to http://localhost:8000/api/v0/character

Expected behavior
The server should be returning the actual data

Screenshots

Desktop:

• OS: Windows
• Browser Chrome
• Version 85

Currently the character images in ./backend/images folder are of different sizes.

Generate new images 300x300px jpg format.

• Indicates that the 300x300px image exists for that character.

Here is the complete list of characters we need images for

• Gary Goodspeed
• Mooncake
• Quinn Ergon
• Little Cato
• Avocato
• KVN
• Ash Graven
• Fox
• H.U.E
• Clarence
• Lord Commander
• Nightfall
• A.V.A
• Tribore
• John Goodspeed
• Sheryl Goodspeed
• Gary Goodspeed (Nightfall's timeline)
• Bolo
• Invictus
• Melanie Dewinter
• Harp Graven
• Shannon Thunder
• Chuck
• Septim
• Fraskenhaur

Write tests for both backend and frontend code.

Following #43 and #74
Limit param will soon be shipped to production, add proper documentaion to both character and endpoint .

Follow this as inspiration
https://finalspaceapi.com/docs/character#sort-the-response

Create a basic README.md file for the backend server.

The README should include but not limited to

• Getting Started
• Project Structure
• How to Install?
• Run Development Server
• Tech Stack (list of dependencies)

If we can send a character status icon, for example a green filled circle for a character that is alive.

It will save a lot of time for devs who are trying to show status using colored icons.

For example

For this we will have to create an icons (preferrably 50x50) jpeg. We only need three icons

• Alive - Green Filled Circle
• Dead/ Deceased - Red Filled Circle
• Operational - Yellow Filled Circle

You can use any icon from web (free icon), or create one in paint.
Just head over to paint and resize the area to 50x50px and create a circle, then fill it with proper color. Should be done in a few times..

Let me know if you have any question

#18 and #25

@stevenjburrows added 15 new characters to the database.

Before adding them to the API response, good 300x300px images are required.

Create images for thses new characters.

Refer #3 and #15

Resources - https://final-space.fandom.com/wiki/Category:Characters

Currently all of the docs under frontend/docs are missing headers.

Add the required headers for better SEO.

Refer here https://v2.docusaurus.io/docs/markdown-features#markdown-headers

P.S. you can leave the image part.

I've selected index.js:Home for refactoring, which is a unit of 146 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

• Definition 📖
  Limit the length of code units to 15 lines of code.
• Why❓
  Small units are easier to analyse, test and reuse.
• How 🔧
  When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

You can find more info about this guideline in Building Maintainable Software. 📖

ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁

Good luck and happy coding! ✨ 💯

#140
To Do

• Create quote.model.js under backend/models
• Create quote.api.js in backend/controllers directory
• Add quotes to routes/routes.js
• Add quote to config/endpoints.js