/go-commerce

An API to control your commerce! :)

Primary LanguageTypeScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Go Commerce

An API to control your e-commerce!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

About The Project

An API to control your e-commerce.

Features:

  • Create a customer (name and email)
  • Create a product (name, price, quantity)
  • Create a order (customer_id and products)
  • Show a order by id

Built With

Getting Started

Prerequisites

  • npm

    npm install npm@latest -g

  • yarn

    npm install --global yarn

  • docker

Installation

  1. Clone the repo 
    git clone https://github.com/jennifertakagi/go-commerce.git
  2. Install packages on backend folder 
    yarn | npm install
  3. Create a Postgress docker image with the following command and options: 
    

    4. 



docker run --go-commerce foo -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres


4. Run database migrations
```sh
yarn typeorm migration:run | npm run typeorm migration:run



    

  1. Run the local environment on backend
    2. 



yarn dev:server | npm run dev:server



Roadmap


See the open issues for a list of proposed features (and known issues).



Contributing


Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.


    

  1. Fork the Project
    2. 

  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. 

  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. 

  4. Push to the Branch (git push origin feature/AmazingFeature)
    5. 

  5. Open a Pull Request
    6. 




License


Distributed under the MIT License. See LICENSE for more information.



Contact


Jennifer Takagi - @jennitakagi



Acknowledgements