{"id":15640374,"url":"https://github.com/lelouchb/final-space-api","last_synced_at":"2025-04-05T06:07:57.132Z","repository":{"id":41968425,"uuid":"300587154","full_name":"lelouchB/final-space-api","owner":"lelouchB","description":"Final Space API : RESTful API based on the show Final Space.","archived":false,"fork":false,"pushed_at":"2024-12-03T14:09:37.000Z","size":41924,"stargazers_count":78,"open_issues_count":5,"forks_count":44,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T05:08:02.750Z","etag":null,"topics":["api","backend","docusaurus2","express","final-space","finalspace","frontend","rest-api","restful-api"],"latest_commit_sha":null,"homepage":"https://finalspaceapi.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lelouchB.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-02T11:01:54.000Z","updated_at":"2024-12-03T14:12:50.000Z","dependencies_parsed_at":"2024-03-01T05:33:37.476Z","dependency_job_id":"92406408-ad8c-4020-926f-165fcd93a508","html_url":"https://github.com/lelouchB/final-space-api","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelouchB%2Ffinal-space-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelouchB%2Ffinal-space-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelouchB%2Ffinal-space-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelouchB%2Ffinal-space-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lelouchB","download_url":"https://codeload.github.com/lelouchB/final-space-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294539,"owners_count":20915340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","backend","docusaurus2","express","final-space","finalspace","frontend","rest-api","restful-api"],"created_at":"2024-10-03T11:35:10.282Z","updated_at":"2025-04-05T06:07:57.116Z","avatar_url":"https://github.com/lelouchB.png","language":"JavaScript","readme":"# Final Space API\n\n  \n\n[![Final Space API](https://raw.githubusercontent.com/lelouchB/lelouchB/master/wallpaper.jpg)](https://finalspaceapi.com)\n\n![](https://img.shields.io/badge/Maintained-Yes-orange)\n![](https://img.shields.io/badge/PRs-Accepting-brightgreen)\n![](https://img.shields.io/github/issues/lelouchB/final-space-api)\n![](https://img.shields.io/github/contributors/lelouchB/final-space-api)\n![](https://img.shields.io/github/issues-pr/lelouchB/final-space-api)\n![](https://img.shields.io/github/license/lelouchB/final-space-api)\n\nThe Final Space API is a RESTful API based on the television show [Final Space](https://en.wikipedia.org/wiki/Final_Space). All the data is taken from [Final Space wiki](https://final-space.fandom.com/wiki/Final_Space_Wiki).\n\n\u003ca href=\"https://www.buymeacoffee.com/ashutoshksingh\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"\u003e\u003c/a\u003e\n\n## Project Structure\n\n```\nfinal-space-api\n├───.github\n│   ├───ISSUE_TEMPLATE\n│   └───workflows\n├───backend\n│   ├───config\n│   ├───controllers\n│   ├───helpers\n│   ├───images\n│   │   ├───character\n│   │   ├───episode\n│   │   └───location\n│   ├───models\n│   └───routes\n└───frontend\n    ├───blog\n    ├───docs\n    ├───src\n    │   ├───css\n    │   └───pages\n    │       └───Components\n    │           ├───Body\n    │           └───Head\n    └───static\n        └───img\n            ├───assets\n            └───pwa\n                ├───android\n                ├───chrome\n                ├───firefox\n                └───msteams\n```\n\n## Installation ⭐\n\nFirst, Clone this repo. Both the frontend and the backend need to be installed seperately.\n\n```bash\ngit clone https://github.com/lelouchB/final-space-api.git\n```\n\nFor **frontend** run the following commands.\n\n```bash\ncd frontend\nnpm install\nnpm run build\n```\n\nIt is important that frontend is installed first and a `build` directory is created since the backend serves this `build` folder.\n\nFor **backend** run the following commands.\n\n```bash\ncd backend\nnpm install\n```\n\n## Starting the Development Server\n\nRun the following command in the backend directory to start the development server at `PORT=8000` by default.\n\n```bash\ncd backend\nnpm run dev\n```\n\nThis will start the development server at [http://localhost:8000](http://localhost:8000).\n**Note :** If `build` folder doen't exist you will see an error at the baseURL i.e. `/`. Create the `build` folder to fix this issue.\n\n## Get Contributing 🤩\n\nFirst things first, In order to contribute you have to create a Pull Request from your forked repo which is a remote clone of this upstream repository.\n\n1. Click this button at the top of screen to fork this repo, **don't forget to star the repository!** ⭐⭐\n   ![form-button](https://github-images.s3.amazonaws.com/help/bootcamp/Bootcamp-Fork.png)\n\n2. Next, clone this repository using\n\n   ```bash\n   git clone https://github.com/lelouchB/final-space-api.git\n   ```\n\n3. It is critical to keep your forked repository in sync with the upstream repository so merge conflicts can be avoided:\n\n   ```bash\n   git remote add upstream https://github.com/lelouchB/final-space-api.git\n   git fetch upstream\n   git pull upstream main\n   git push\n   ```\n\n4. Create a new branch to work upon\n   The branch name must be selected according to the issue\n\n   ```bash\n   git checkout -b \u003cbranch-name\u003e\n   ```\n\n5. After the contribution work is ready, go ahead and add it to the staging area:\n\n   ```bash\n   git add -A\n   ```\n\n6. Now it is time to commit your changes and sync these changes to the forked repo:\n\n   ```bash\n   git commit -m \u003cyour_message\u003e\n   git push origin \u003cbranch-name\u003e\n   ```\n\n   **Note :** Branch Name is the branch you created earlier\n\n7. Issue a pull request from forked repo to this repo by clicking on `New Pull Request`:\n   ![](https://guides.github.com/activities/hello-world/create-pr.png)\n\n8. Fill in the title and provide a concise description.\n9. Wait for respose on the PR. Congratulations you just contributed to open source! 👏👏\n\n### Contributing to Frontend\n\nThe frontend of this project is made with [Docusaurus](https://v2.docusaurus.io/docs/) and [React](https://reactjs.org/).\nTo start the dev server, run the following commands in `frontend` directory:\n\n```bash\ncd frontend\nnpm start\n```\n\nThis will start the frontend dev server on [http://localhost:3000](http://localhost:3000).\n\nAfter you have done with your contribution, create the production build by running the following commands:\n\n```bash\ncd frontend\nnpm run build\nnpm run serve\n```\n\nThe last command will server the build folder on [http://localhost:3000](http://localhost:3000).\n\nMake sure your contributions are reflected properly in this build.\n\n**For more details related to installation and requirements please check the README in Frontend directory.**\n\n### Contributing to Backend\n\nThe backend is made with **NodeJS**, **Express** and **MongoDB**.\nRun the following commands to open the dev server.\n\n```bash\ncd backend\nnpm run dev\n```\n\nHead to [http://localhost:8000](http://localhost:8000), if a `build` folder is present in `frontend` directory then you will see the landing page of the project.\n\n**For more details related to installation and requirements please check the README in Backend directory.**\n\n## License\n\nFinal Space is created by Olan Rogers for [TBS](https://www.tbs.com/) and later picked by [Adult Swim](https://www.adultswim.com). The data and images are used without claim of ownership and belong to their respective owners.\n\nThis API is open source and uses a [BSD license](/LICENSE).\n","funding_links":["https://www.buymeacoffee.com/ashutoshksingh"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flelouchb%2Ffinal-space-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flelouchb%2Ffinal-space-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flelouchb%2Ffinal-space-api/lists"}