https://github.com/joelluna02/idolapi

The New Idol fanmade REST API
https://github.com/joelluna02/idolapi

api-rest babel beta-release express expressjs graphql handlebars idol idol-corp javascript rest-api vtuber

Last synced: 2 days ago
JSON representation

The New Idol fanmade REST API

• Host: GitHub
• URL: https://github.com/joelluna02/idolapi
• Owner: JoelLuna02
• License: mit
• Created: 2024-05-01T04:03:16.000Z (5 months ago)
• Default Branch: Express
• Last Pushed: 2024-09-15T03:14:04.000Z (13 days ago)
• Last Synced: 2024-09-20T18:33:13.910Z (7 days ago)
• Topics: api-rest, babel, beta-release, express, expressjs, graphql, handlebars, idol, idol-corp, javascript, rest-api, vtuber
• Language: JavaScript
• Homepage: https://idolapi.koyeb.app/
• Size: 3.73 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  


# **IdolAPI - the Idol fanmade REST API**

![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/JoelLuna02/IdolAPI/Express)

![GitHub License](https://img.shields.io/github/license/JoelLuna02/IdolAPI)

![GitHub Release](https://img.shields.io/github/v/release/JoelLuna02/IdolAPI?include_prereleases)

![GitHub Sponsors](https://img.shields.io/github/sponsors/JoelLuna02?style=flat&logo=github&label=Sponsors&color=green)

![Koyeb](https://img.shields.io/badge/-Koyeb-121212?style=flat&logo=koyeb&logoColor=white)



IdolAPI, an open source platform based on [Idol corp](https://idol-company.com)., designed to facilitate learning and practicing key REST API development concepts.

## Getting Started

![Node LTS](https://img.shields.io/node/v-lts/eslint?color=green) ![NPM Version](https://img.shields.io/npm/v/eslint)

You can configure locally by following these steps:

- Install the node.js dependencies:

  ```powershell

  npm i --save

  ```

- Then define the following variables in your .env.local file:

  ```bash

  MONGODB_URI="mongodb://"

  MONGODB_NAME=""

  MONGODB_OPTIONS="?" #Optional

  SECRET_KEY="YOUR-SECRET-KEY"

  ```

- And finally, run the server in development mode:

  ```powershell

  npm run dev

  ```

  Open [http://localhost:3000](http://localhost:3000) with your browser.

## Documentation

Take a look at the [documentation](http://localhost:3000/docs) for more information on using the app.

---

## Support this project ![Ko-fi Badge](https://img.shields.io/badge/Ko--fi-FF5E5B?logo=kofi&logoColor=fff&style=flat)

🙏 Please consider supporting us, no matter how big or small the contribution is. It would help us a lot to continue keeping this API with its data updated and protected from any malicious attack.

 

    



---

## ~~**Become a sponsor!**  ![Github Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-EA4AAA?logo=githubsponsors&logoColor=fff&style=flat)~~

~~You can also become a Sponsor through [Github Sponsors](#).

Your Name and your avatar will be displayed in future projects and websites.~~

> Comming soon...