Skip to content

r3nanp/sellapi

Repository files navigation

SellApi

A API to make sells!

r3nanp license mit prs

Technologies used ๐Ÿ› 

  • Node.js
  • Express
  • Yup
  • TypeORM
  • PostgreSQL

Contributing ๐ŸŽ‰

Check this step by step


๐Ÿ‘ทโ€โ™‚๏ธ Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/r3nanp/sellapi.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

git clone git@github.com:r3nanp/sellapi.git

Install dependencies

yarn install

Or

npm install

Create your enviroment variables based on the examples of .env.example

cp .env.example .env

After copying the examples, make sure to fill the variables with new values.

Setup a database

Install Postgres to create a database or if you have Docker in your machine, fill the environment values related to database configurations and then run the following commands in order to create a Postgres container.

docker-compose up -d

๐Ÿƒ Getting Started

Run the transactions in order to configure the database schema

yarn typeorm migration:run

Run the following command in order to start the application in a development environment:

yarn dev

๐Ÿ“• License

Released in 2021. This project is under the MIT license.

Made with love by Renan Pereira ๐Ÿ’œ๐Ÿš€