Blogging API

Welcome to St. Pardon blogging api, feel free to explore and contribute. You can reach out for collabouration

About

The blogging api works on the principle of creating a post and having it read by other people.

The general idea is that the api has a general endpoint that shows a list of articles that have been created by different people, and anybody that calls this endpoint, are able to read a blog created by them or other users.

Getting Started

• Open your terminal
• Clone the repo and enter the directory

$ git clone https://github.com/st-pardon/blogging-api.git 
$ cd blogging-api/

• Install packages and dependecies

$ npm install

• Create a .env file and Set up every environmental variable required

  see .env for required variables

• Start the App

$ npm start

Congratulations, you have successfully started your App, explore the API Docs for full list of routes/paths

Doucmentation

For complete list of the API Documetation, visit API docs

• Hosts:
  • Remote - https://odd-plum-walrus-kilt.cyclic.app
  • Local - http://Localhost:[PORT]
• Home Route - /

http://<hostdomain>/

• Sign Up - /signup

http://<hostdomain>/signup

• Sign In - /signin

http://<hostdomain>/signin

• Blog posts - /posts

http://<hostdomain>/posts

• Create Blog posts - /posts/new_post

http://<hostdomain>/posts/new_post

Deploy

The App is Live At Blogging API 🚀🚀🚀

Don't forget to leave a Star