Giter Club home page Giter Club logo

udacity-ecommerce's Introduction

Reviews API

Supports operations for writing reviews and listing reviews for a product but with no sorting or filtering.

Prerequisites

  • MySQL installed and configured to run on localhost, port 3306.
  • If you don't want to change application.properties, configure the following settings in your SQL server:
    • Create a database called ecommerce.
    • Create a user with "readWrite" access to ecommerce.
      • Username = dev_user
      • Password = password
    • Flyway will create and seed the necessary tables so that you can begin playing with the API immediately on your first run.
      • If you do not want your tables seeded, remove the V2__SeedTables.sql file from the db.migration folder.
  • MongoDB installed and configured to run on localhost, port 27017.
  • If you don't want to change application.properties, configure the following database and collection settings in your Mongo server.
    • Create a database called ecommerce.
    • Create a user in the admin database with "readWriteAnyDatabase" access.
      • Username = dev_user
      • Password = password
    • If you want to seed your tables using the same data that Flyway uses to seed the SQL tables, open your cmd shell in the db.migration folder.
      • Make sure your mongod service is running.
      • In the cmd shell, type the following command: mongo --quiet SeedMongoCollection.js.
        • Alternatively, you can start the mongo interactive shell and type load("SeedMongoCollection.js").
      • The console will print some messages and the data will be seeded.

API Documentation

  • API documentation is created using the Swagger library.
  • API documentation can be found at the following URL, once the application itself is running:
    • http://localhost:8080/swagger-ui.html

Technical Notes

Database Structure

  • Database Name: ecommerce
  • Tables
    • products
    • reviews
    • comments
  • Relationships
    • products to reviews, one-to-many
    • reviews to products, many-to-one
    • reviews to comments, one-to-many
    • comments to reviews, many-to-one

Database Schema Database Schema

Reference Documentation

For further reference, please consider the following sections:

Guides

The following guides illustrate how to use some features concretely:

udacity-ecommerce's People

Contributors

technakal 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.