README.md

About

Welcome to Mocked-API, this is a live API that can be accessed by anyone who needs data to test out their website, app, components etc.

Sponsors

We are eternally greatful for the amazing sponsors of this project. They help provide this little birdy with a home to live in. So thank you to the following sponsors for their contributions to the platform.

If you would like to help support this project. We now have an Open Collective page which you can visit here

Getting Started

First you should head over to https://api.mocked-api.dev and read our live api docs than start calling the api endpoints for the data you need.

Join our discord

How to run Mocked-API

Once you've cloned this repository, running Mocked-API is quite easy, there are just 2 steps you have to follow:

1. Install the dependencies

npm install

2. Configure the application An example configuration file .env.example is provided.

npm run config

3. Serve the application

npm run serve

This will show you where the application is running

Mock API is running on port 3000.

Getting Started (Docker)

1. Ensure you have Docker installed
2. Open your terminal/command line tool
3. Run docker-compose up
4. Open your browser to http://localhost:3000/

Now you should be able to make any request to that port, and get a response back!

💡 If you browse to that port, you'll see our swagger documentation.

FAQ

Q: Are you planning to add more end points?
A: I plan to add as many as I can, if there is a specific endpoint of data you would like to see feel free to add a Issue Request.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

I encourage you to contribute to Mocked-API! Feel free to fork the codebase and make a pull request for your changes.

Our contributing guide is currently WIP and available here CONTRIBUTING GUIDE

Sponsor

Do you like this project? Support it by donating.

Buy Me A Coffee

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ahmed Silat 💻	Yasio 💻	Alberto Herrera Vargas 📖	Coşkun Atak 💻	Rizky ian indiarto 💻	Evan 💻	Trigstur 💻
fadkeabhi 💻	Thomas Martin 💻 ⚠️	Vu 💻 📖	Kalwabed Rizki ⚠️	Talison Fabio 💻	Chris Jones 🔧	jkol7 💻
Siddharth Pandey 💻	Alex Harrison 💻	Derzan Chiang 💻	ATH 📖	Suraj Bhandarkar S ⚠️	Fernando Guerrero 📖 ⚠️	Anish De 📖
Vaibhav Garje 💻 ⚠️	Mayank Singh 📖	Mike Hingley 💻	krishna 💻	Vadym Yatsyuk 📖	Nicholas Robert Beckham ⚠️	Ayanwola Ayomide 💻 ⚠️ 📖
Zuhaib Shah 💻	Guilherme Fernandes 💻	Ben Halverson 💻 ⚠️	Ayush Chauhan ⚠️ 💻	Edwards Moses 📖 ⚠️	Rajitha Gunathilake 💻	Bram Musuko Panjaitan ⚠️
filip 💻	Farhaan 💻	lauk20 💻	Sherly Febrianti 📖	headStyleColorRed 💻	mdmuaj13 💻	Christopher Vestman 💻
Ava Elise 💻	Janet Thieu 💻	Vishwa Mahadevan 💻	Christa 📖	Bruno Vilar 📖	Vitor 💻	Palaniappan 💻
Suppergerrie2 💻	Dipendra Shrestha 💻	Elijah Soladoye 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!