nezamedia-backend

Introduction

This is a nezago project of managing media (videos, audios, documents). This part is for backend

Vision

Since the rise of technology, everyhing is easier to be maintened, for the media such as: * Videos * Audios * Documents We are here to provide the easiest way of maintening them!

Tools

Tools used for development of these APIs are;

• Code Editor: VSCode.

• Languages :

  • Backend:
    • NodeJS => Express (framework)
    • PostgreSQL

• API Testing tools:

  • Postman
  • Mocha and chai

• Test Coverage, maintainability, and CI:

  • Travis CI,
  • Codecov

• Version control system: Git

Testing endpoint locally

Prerequisites

Make sure you have:

• NodeJS 10 or newer
• PostgreSQL

Clone the Repo.

1. git clone https://github.com/nezago/nezamedia-backend.git
2. cd nezamedia-backend
3. create a .env file in parent directory of the project
4. copy all fields from .env.example file and paste them in .env file, and give them values
5. yarn or npm i
6. yarn run migrations or npm run migrations
7. yarn start or npm start
8. If you have Postman already installed on your local machine, then test all of the above listed endpoints
9. Remember to run PostgreSQL 9 or above on your local machine or in a container

Deployment

• Heroku (Backend) : NezaMedia Backend

Key contributor to development

• MUGIRASE Emmanuel (descholar)

API Endpoints Specifications

• Api Roots : https://nezamedia-backend-staging.herokuapp.com/api/

Endpoint	Request	Status	Description
/	GET	200 OK	Helps users to access to the parent api for the whole application
/users/signup	POST	201 CREATED	Helps users to create their accounts, by signup
/users/verify-user?token=token	GET	200 OK	Verifies a user after a successful registration
/users/login	POST	200 OK	Enables user to login after their account has been verified
/users/resend-verification-email?email=requesterEmail	POST	200 OK	Enables user to request resend verification email
/users/reset-password-request?email=requesterEmail	POST	200 OK	Enables user to request to reset the password
/users/reset-password/:token	PATCH	200 OK	Enables user to reset their password
/users/login-google	GET	200 OK	Enables user to login via their google accounts
/users/login-facebook	GET	200 OK	Enables user to login via their facebook accounts
/users/logout	GET	200 OK	Enables user to logout