{"id":20617615,"url":"https://github.com/lat0s/flossophyrest","last_synced_at":"2026-03-01T19:33:49.662Z","repository":{"id":263041020,"uuid":"889108307","full_name":"lat0s/FlossophyREST","owner":"lat0s","description":"🪶RESTAPI for Flossophy using Koa.js and MongoDB.","archived":false,"fork":false,"pushed_at":"2025-03-17T18:46:05.000Z","size":249,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T19:41:21.036Z","etag":null,"topics":["backend","backend-api","javascript","koa","koajs","koajs-starter-template","rest","rest-api","restapi"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lat0s.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-15T16:16:32.000Z","updated_at":"2025-03-17T18:46:07.000Z","dependencies_parsed_at":"2024-11-15T19:29:55.102Z","dependency_job_id":"89e692ad-20c2-4a94-8dc4-7e036a772439","html_url":"https://github.com/lat0s/FlossophyREST","commit_stats":null,"previous_names":["lat0s/flossophyrest"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lat0s/FlossophyREST","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lat0s%2FFlossophyREST","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lat0s%2FFlossophyREST/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lat0s%2FFlossophyREST/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lat0s%2FFlossophyREST/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lat0s","download_url":"https://codeload.github.com/lat0s/FlossophyREST/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lat0s%2FFlossophyREST/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260985197,"owners_count":23092888,"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":["backend","backend-api","javascript","koa","koajs","koajs-starter-template","rest","rest-api","restapi"],"created_at":"2024-11-16T12:05:00.288Z","updated_at":"2026-03-01T19:33:49.612Z","avatar_url":"https://github.com/lat0s.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --\u003e\n\n\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Don't forget to give the project a star!\n*** Thanks again! Now go create something AMAZING! :D\n--\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/lat0s/FlossophyREST\"\u003e\n    \u003cimg src=\"assets/flossophy.png\" alt=\"Logo\" width=\"256\" height=\"256\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eFlossophy Rest API\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    🪶RESTAPI for Flossophy using Koa.js and MongoDB.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/lat0s/FlossophyREST\"\u003e\u003cstrong\u003eExplore the docs (!WIP!) »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/lat0s/FlossophyREST\"\u003eView Demo (!WIP!) \u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/lat0s/FlossophyREST/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/lat0s/FlossophyREST/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Built With\n\n- [![Node.js][Node]][Node-url]\n- [![Koa][Koa]][Koa-url]\n- [![MongoDB][Mongo]][Mongo-url]\n\nAlso uses:\n- Nodemailer\n- Argon2\n- Jsonwebtoken\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nFollowing the guide with steps listed below will help you run this application.\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/en) Latest Version\n- [MongoDB](https://www.mongodb.com/) Locally hosted or Atlas (please look elsewhere for details on how to install them.)\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/lat0s/FlossophyREST.git\n   ```\n\n\u003cbr\u003e\n\n2. Navigate to `/app` directory, open a new terminal and write the following command\n\n   ```sh\n   npm install\n   ```\n\n\u003cbr\u003e\n\n3. Create a new empty file named `.env` or rename `.env.example` =\u003e `.env`\n\n\u003cbr\u003e\n\n4. Enter the following in `.env` (skip if you renamed the `.env.example`)\n   ```js\n   SMTP_SERVICE=\u003cYOUR_SERVICE\u003e\n   SMTP_USER=\u003cYOUR_EMAIL\u003e\n   SMTP_PASS=\u003cYOUR_PASS\u003e\n   EMAIL_FROM=\u003cYOUR_EMAIL\u003e\n   MONGODB_URI=\u003cYOUR_MONGODB_URI\u003e\";\n   ```\n\n\u003cbr\u003e\n\n5. Look [here](https://medium.com/@deepbag/how-to-send-mail-using-nodemailer-for-free-f8e3df6f7cf6) for more information. I personally used Gmail and followed the instructions on the link. If u follow the guide then the password in `SMPT_PASS` should be the one u copied from the App Password. The `SMTP_USER` should be the Gmail address and the `SMTP_SERVICE=gmail`.\n\n\u003cbr\u003e\n\n6. Run the application\n   ```sh\n   node app.js\n   ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## Usage\n\nThis REST API is intented for usage within the Flossophy Full-Stack Project (!WIP!).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\n- [ ] N/A\n\nSee the [open issues](https://github.com/lat0s/FlossophyREST/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star⭐! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the Apache 2.0 License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\nX - [@lat0ss](https://twitter.com/lat0ss)\nDiscord - [@lesbiathan](https://discord.com/users/989771998899109951)\n\nProject Link: [https://github.com/lat0s/FlossophyREST](https://github.com/lat0s/FlossophyREST)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003chr\u003e\n\n## \u003c!-- Footer --\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"./assets/footer.svg\"\u003e\n\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[Nodemailer-url]: https://www.nodemailer.com/\n[Mongo]: https://img.shields.io/badge/MongoDB-47A248?logo=mongodb\u0026logoColor=fff\u0026style=flat-square\n[Mongo-url]: https://www.mongodb.com/\n[Node]: https://img.shields.io/badge/Node.js-5FA04E?logo=nodedotjs\u0026logoColor=fff\u0026style=flat-square\n[Node-url]: https://nodejs.org/en\n[Koa-url]: https://koajs.com/\n[Koa]: https://img.shields.io/badge/Koa-33333D?logo=koa\u0026logoColor=fff\u0026style=flat-square\n[contributors-shield]: https://img.shields.io/github/contributors/lat0s/FlossophyREST.svg?style=for-the-badge\n[contributors-url]: https://github.com/lat0s/FlossophyREST/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/lat0s/FlossophyREST.svg?style=for-the-badge\n[forks-url]: https://github.com/lat0s/FlossophyREST/network/members\n[stars-shield]: https://img.shields.io/github/stars/lat0s/FlossophyREST.svg?style=for-the-badge\n[stars-url]: https://github.com/lat0s/FlossophyREST/stargazers\n[issues-shield]: https://img.shields.io/github/issues/lat0s/FlossophyREST.svg?style=for-the-badge\n[issues-url]: https://github.com/lat0s/FlossophyREST/issues\n[license-shield]: https://img.shields.io/github/license/lat0s/FlossophyREST.svg?style=for-the-badge\n[license-url]: https://github.com/lat0s/FlossophyREST/blob/main/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/latosgeorge\n[product-screenshot]: images/screenshot.png\n[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge\u0026logo=nextdotjs\u0026logoColor=white\n[Next-url]: https://nextjs.org/\n[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB\n[React-url]: https://reactjs.org/\n[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge\u0026logo=vuedotjs\u0026logoColor=4FC08D\n[Vue-url]: https://vuejs.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flat0s%2Fflossophyrest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flat0s%2Fflossophyrest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flat0s%2Fflossophyrest/lists"}