adoidadox2 / tsc-crud-pg

Typescript version of the project - https://github.com/adoidadox2/selectFullStackDeveloper

tsc-crud-pg

About the project 📂:

Project - https://github.com/adoidadox2/selectFullStackDeveloper

Made now in typescript and typeorm for future revisions (used soft delete)

Technologies 🚀:

Technologies that I used to develop this API

• Node.js
• TypeScript
• Express
• TypeORM
• JWT
• PostgreSQL
• Helmet
• Celebrate
• Cors
• Express-brute

Getting started 🖥️:

Import the Insomnia.json on Insomnia App

Requirements

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

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/adoidadox2/tsc-crud-pg.git && cd tsc-crud-pg

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env

# Create the instance of postgreSQL using docker
$ docker run --name tsc-crud-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=tsc-crud -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d -t postgres

# Create the instance of Redis using docker
$ docker run --name tsc-crud-redis -p 6379:6379 -d -t redis:alpine

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

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

# Well done, project is started!

How to contribute 🤔:

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork adoidadox2/tsc-crud-pg

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd tsc-crud-pg

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

License 📝:

This project is licensed under the MIT License - see the LICENSE file for details.

---

Author 👨‍💻:

Made with ❤️ by Augusto Vinícius 👋🏻 Get in touch!