Redis Cache

About the project   |    Technologies   |    Getting started   |    License

👨🏻‍💻 About the project

This project was made with the aim of studying how Redis works.

🚀 Technologies

Technologies that I used to develop this API:

• Node.js
• TypeScript
• Express
• PostgreSQL
• Redis
• JWT-token
• CryptoJS
• uuid v4
• Eslint
• Prettier

💻 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
• One instance of Redis

Obs.: We are going to use docker compose to instantiate the databases, you must have a postgreSQL and a Redis image.

Clone the project and access the folder

$ git clone https://github.com/GabrielCordeiroDev/redis-cache
$ cd redis-cache

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

# PostgreSQL and Redis 
$ docker-compose up -d

# To finish, run the api service
$ yarn dev

# Well done, project is started!

📝 License

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