Code Monkey home page Code Monkey logo

blogify's Introduction

Blogify

Blogify is a blog web application, a platform where users can create posts, read posts, comment on posts and also like those posts.

Getting Started

Clone this repository

URL: https://github.com/abdul-razaq/Blogify.git

Prerequisites

  • node v12.16.1 or above
  • yarn v1.22.4 or above

Endpoints

HTTP VERB ENDPOINT FUNCTIONALITY
POST /api/v1/auth/signup Register a new user account
POST /api/v1/auth/login Login user into an existing account
POST /api/v1/auth/logout Logout user from the application
PATCH /api/v1/auth/password/update Update user's password
GET /api/v1/auth/user/profile Retrieve a user's profile details
PATCH /api/v1/auth/user/profile/edit Edit a user's profile
DELETE /api/v1/auth/user/delete Delete a user's account
POST /api/v1/posts/ Create a new post
GET /api/v1/posts?limit=10 Retrieve all posts belonging to the user
DELETE /api/v1/posts/{postId} Delete a post belonging to the user
GET /api/v1/posts/{postId} Retrieve a single post belonging to the user
GET /api/v1/posts/feeds?limit=10 Retrieve all posts feeds with a limit

Installation

On your machine

  • Pull the [master] (https://github.com/abdul-razaq/Blogify.git) branch of this repository

  • Configure a .env file in the root directory with the following variables

  • JWT_SECRET (JWT secret key)

  • DB_PASSWORD (Database Password)

  • DB_NAME (Database name (blogify))

  • DB_USER (Database user)

  • Run yarn install OR yarn add to install all dependencies

  • Run yarn run dev to start the app server

  • Access endpoints on localhost:5000

Run Tests

Run yarn run test in the terminal from the root directory of the cloned repo.

Built With

Heroku Link

URL: https://blogify-api.herokuapp.com/

API Documentation

URL: https://blogify-api.herokuapp.com/api-docs

Authors

  • AbdulRazaq Ayomide Suleiman

blogify's People

Contributors

abdul-razaq avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.