Very useful tools to remember

Technologies   |    Getting started

🚀 Technologies

• Node.js - A JavaScript runtime built on Chrome's V8 JavaScript engine.
• TypeScript - An open-source language which builds on JavaScript and adds static type definitions.
• Express - Fast, unopinionated, minimalist web framework for Node.js.
• BcryptJS - Optimized bcrypt in plain JavaScript with zero dependencies.
• Tsyringe - Lightweight dependency injection container for JavaScript/TypeScript.
• Json Web Token - JsonWebToken implementation for Node.js.
• Celebrate - A joi validation middleware for Express.
• PostgreSQL - An open source database system.
• Docker - A platform built for developers to build and run applications.
• Typeorm - ORM for TypeScript and JavaScript.
• Jest - Delightful JavaScript Testing.
• Swagger Ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation.
• Eslint - Pluggable JavaScript linter.
• Prettier - An opinionated code formatter.
• VS Code - Code Editing.
• EditorConfig - Helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.

📝 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn or npm
• One instance of PostgreSQL

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/greysonmrx/vuttr-backend.git
$ cd vuttr-backend

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
$ cp .env.example .env

# Create the instance of postgreSQL using docker
$ docker run --name vuttr-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

# Start container
$ docker start vuttr-postgres

# Now you need to create two databases: vuttr and vuttr-tests

# Once the services are running, run the migrations
$ yarn typeorm migration:run

# Run the tests
$ yarn test

# To finish, run the api service
$ yarn dev:server

# Well done, project is started!

To see the documentation, click here: Documentation
Or if you aren't running the API locally, click here: Documentation

Made with ♥️ by Greyson 👋 See my linkedin