Unofficial Kabum Digital API

This is an unofficial Kabum Digital API. The API provides endpoints to access posts and their content from the Kabum Digital website. For detailed information about the endpoints, please check endpoints.md.

Tech stack 📚

(back to top)

🚀 How to Run Locally

To run the project locally, follow these steps:

1. Clone the repository from GitHub:

   git clone https://github.com/JefferMarcelino/unofficial-kabum-digital-api.git
   

2. Install dependencies:

   cd unofficial-kabum-digital-api
   npm install
   

3. Ensure you have Redis installed and running on your machine.

4. Start the local server:

   npm run dev
   

The API should now be accessible at http://localhost:3000.

(back to top)

Contributing

If 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". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: add caching to improve performance')
4. Push to the Branch (git push origin feat/AmazingFeature)
5. Open a Pull Request

(back to top)

📝 License

This project is under the MIT license. See the LICENSE file for more details.

---

Made with ♥ by Jeffer Marcelino