Code Monkey home page Code Monkey logo

groupbackend's Introduction

ER diagram

ER Diagram

Backend Assignment - API

This is the README for an Express backend assignment that requires you to implement the REST APIs for an E-commerce based on the Entity-Relationship Diagram (ERD) assignment. The ERD assignment should outline the data model, including the relationships and attributes of entities within the system. You are tasked with designing and documenting the REST APIs according to the ERD specifications.

Introduction

This Express backend assignment involves building a RESTful API for an E-commerce. You are provided with an Entity-Relationship Diagram (ERD) assignment that outlines the data model, including the relationships and attributes of entities such as products, users, orders and admin roles.

Entity CRUD Operations

Before implementing JWT authentication, you are required to create the basic CRUD (Create, Read, Update, Delete) operations for the entities based on the specifications provided in the ERD assignment. This section focuses on designing and implementing the core functionality to manage and interact with the specified entities.

Authentication

For security, this API should implement user authentication using JSON Web Tokens (JWT). Each user should have a unique username and password OR broker authentication. Certain admin endpoints may require special privileges for access.

Minimum requirements

The minimum requirements of the project.

  1. Products
  • Attributes: ID, name, description, categories, variants/ sizes
  • Get list of all products with/without pagination
  • Get list of products, filtering (search) by: name, categories, variant
  • Get a product by ID
  1. Users
  • Attributes: ID, first name, last name, email
  • Sign up a new user (username, password, first name, last name, email)
  • Sign in user with username/password
  • Update user profile (first name, last name, email)
  • Forget password request
  • Change password (username, old password, new password)
  1. Admin Special users with certain privileges
  • Add a new product, update info of a product, remove a product
  • Ban a user, unban a user

Response Format

All API responses should be provided in JSON format. A typical response should include a status, data, and an optional message field. The status field should indicate the success or failure of the request.

Error Handling

The API should include comprehensive error handling with clear and informative error messages. Errors should be accompanied by appropriate HTTP status codes.

Testing

Developers should conduct unit tests and integration tests to ensure the reliability and correctness of the API. Instructions for running the tests should be provided in the project's documentation.

Deployment

The API should be deployed before the DEADLINE

groupbackend's People

Contributors

xiaoshuzhou avatar mannisingh avatar gugu9911 avatar andreaa-dev avatar

Watchers

 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.