IdolAPI - the Idol fanmade REST API

IdolAPI, an open source platform based on Idol corp., designed to facilitate learning and practicing key REST API development concepts.

Getting Started

You can configure locally by following these steps:

• Install the node.js dependencies:

  npm i --save

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

  MONGODB_URI="mongodb://<Your-Mongodb-Connection>"
  MONGODB_NAME="<Your-Database-name>"
  MONGODB_OPTIONS="?<Option-Parameters>" #Optional
  SECRET_KEY="YOUR-SECRET-KEY"

• And finally, run the server in development mode:

  npm run dev

  Open http://localhost:3000 with your browser.

Documentation

Take a look at the documentation for more information on using the app.

---

Support this project

🙏 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!

You can also become a Sponsor through Github Sponsors. Your Name and your avatar will be displayed in future projects and websites.