anshour / simple-blog-api

A blog API for learning purposes

Home Page:https://simple-blog-api.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Simple Blog API

Welcome to the Simple Blog API repository! This project is an easy-to-use API for a blogging platform, designed with simplicity and performance in mind. Built on the robust Next.js framework and leveraging the power of MongoDB's Data API, this API is perfect for beginners looking to get their hands dirty with backend development or for anyone in need of a lightweight blogging solution.

πŸš€ Features

  • Next.js App Router: Utilizes the latest Next.js App Router for efficient routing.
  • Edge Runtime: Delivers fast response times by running on the edge.
  • MongoDB Integration: Stores data securely with MongoDB via the Data API.
  • Cost-Efficient: Operate your blog at no cost with Vercel's free tier and MongoDB's free tier.
  • Beginner-Friendly: Designed to be straightforward and easy to use, making it perfect for those new to API development.

πŸ“š API Documentation

For a comprehensive guide and to explore the endpoints available, check out the API documentation:

πŸ”— Simple Blog API Documentation

πŸ›  Tech Stack

This project is built using the following technologies:

  • Next.js App Router + Edge Runtimes: For serverless API routes that run on the edge.
  • MongoDB: Leveraging the MongoDB Data API for database operations.
  • TypeScript: Ensuring type safety and enhancing the development experience.

πŸ“¦ Getting Started

To get started with this project, you'll need to have Node.js installed on your machine. Follow these steps to set up the project locally:

  1. Clone the repository:

    git clone https://github.com/your-username/simple-blog-api.git
  2. Navigate to the project directory:

    cd simple-blog-api
  3. Install dependencies:

    npm install
  4. Set up your environment variables by creating a .env.local file with the necessary credentials for MongoDB.

  5. Run the development server:

    npm run dev

    Your API will now be running on http://localhost:3000.

🀝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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 feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ“ License

Distributed under the MIT License. See LICENSE for more information.

πŸ“© Contact

Project Link: https://github.com/your-username/simple-blog-api


Thank you for visiting the Simple Blog API repository. We hope you find this project useful!

About

A blog API for learning purposes

https://simple-blog-api.vercel.app


Languages

Language:TypeScript 68.1%Language:CSS 31.5%Language:JavaScript 0.5%