https://github.com/trasherdk/codesandbox-ecommerce-shop

https://github.com/trasherdk/codesandbox-ecommerce-shop

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/trasherdk/codesandbox-ecommerce-shop
• Owner: trasherdk
• Created: 2021-08-02T06:29:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-24T23:43:28.000Z (over 1 year ago)
• Last Synced: 2023-03-03T21:09:40.159Z (over 1 year ago)
• Language: JavaScript
• Size: 4.09 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Turing Back End Challenge

To complete this challenge, you need to ensure all route returns a similar response object as described in our API guide.

To achieve this goal

- You will have to fix the existing bugs

- Implement the incomplete functions,

- Add test cases for the main functions of the system.

- Add Dockerfile to the root of the project to run the app in docker environment

## Getting started

### Prerequisites

In order to install and run this project locally, you would need to have the following installed on you local machine.

* [**Node JS**](https://nodejs.org/en/)

* [**Express**](https://expressjs.com/)

* [**MySQL**](https://www.mysql.com/downloads/)

### Installation

* Clone this repository

* Navigate to the project directory

* Run `npm install` or `yarn` to instal the projects dependencies

* create a `.env` file and copy the contents of the `.env.sample` file into it and supply the values for each variable

```sh

cp .env.sample .env

```

* Create a MySQL database and run the `sql` file in the database directory to migrate the database

```sh

mysql -u  -D  -p < ./src/database/database.sql

```

* Run `npm run dev` to start the app in development

## Docker

* Build image

`docker build -t node_challenge .`

* Run container

`docker run --rm -p 8000:80 node_challenge`

## Request and Response Object API guide for all Endpoints

Check [here](./Backend-Challenge-API-Template.md)