EnsiaSeaBack

Welcome To EnsiaSea

Introduction

EnsiaSea is a project built (or still in the buidling phase) by second year Software Engineering students from ENSIAS. As you can see from its name, it has combined the two words ENSIAS and SEA, this combination was based on the website OpenSea, and if you can't guess yet, the goal of this project is to build a blockchain website for ENSIAS students to sell, buy, and exchange NTFs (Non Fungible Tokens). To make this project come true, it was devided into 3 parts: The blockchain network, the back-end, and the front-end of the website. This repository is the main one, and it contains the BackEnd part of the project.

Api Endpoints

EnsiaSea API has multiple endpoints that follow the same structure /api/v1/endpoint

• For Authentication :

  • Register a User :

  Endpoint :POST /auth/register

  PayLoad :

      {
          "email": Email of the user must be unique,
          "username": Username of the user must be unique,
          "password": ******
      }
  

  OutPut :

      {
          "success" : false || true ,
          "message" : success message || error message
      }
  

  • Login a User :

  Endpoint : POST /auth/login

  PayLoad :

      {
          "email": Email of the user,
          "password": ******
      }
  

  OutPut :

      {
          "success" : false || true ,
          "message" : success message || error message
      }
  

  • Logout a User :

  Endpoint : POST /auth/logout

  OutPut :

      {
          "success" : false || true ,
          "message" : success message || error message
      }
  

• To Handle Users :

  • Get All Users :

  Endpoint : GET /users/

  OutPut :

      {
          "success" : false || true ,
          "message" : success message || error message,
          "count" : number of users in the database,
          "data" : [ Users...]
      }