Skip to content

Quick api to test and discover how redis works. For best portability i added docker.

License

Notifications You must be signed in to change notification settings

Michelprogram/redis-golang

Repository files navigation


Logo

Golang with Redis,Docker and Mongo

Quick api to test and discover how redis works. For best portability i added docker.


Table of Contents
  1. 🧭 About The Project
  2. 📋 Getting Started
  3. 💾 Usage
  4. 🔗 Contributing
  5. 📰 License
  6. 📫 Contact
  7. ⛱️ Acknowledgments

🧭 About The Project

🏗️ Built With

List of technologies / frameworks used during the project.

  • Go Badge
  • Redis Badge
  • Mongo Badge
  • 🐋 Docker

⬆️

📋 Getting Started

To get a local copy up and running follow these simple example steps.

🗺️ Prerequisites

If you run project directly with docker-compose skip these steps

  • Golang compiler under version 1.18 should work.
  • Redis 3.16
  • Mongo 5.0.8
  • Docker
  • Docker-compose

Also you need to create .env at the root folder project :

PWD_REDIS=password_redis

ID_MONGO=api_user
PWD_MONGO=password_mongo
DB_MONGO=api_prod_db

ROOT_MONGO=root
ROOT_PWD_MONGO=password

⬆️

💾 Usage

To build api :

$bash : chmod +x build.sh
$bash : ./build.sh #That script will create dist folder

To run api

$bash : ./dist/api-golang port

To check request

$bash : curl http://locahost:port/redis
$bash : curl http://locahost:port/notredis

Run with docker-compose

$bash : docker-compose up --build -d
$bash : docker ps container # Check containers running

⬆️

🔗 Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

⬆️

📰 License

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

⬆️

📫 Contact

Reach me at : gauron.dorian.pro@gmail.com.

Project Link: https://github.com/Michelprogram/blind-test.git

⬆️

⛱️ Acknowledgments

This space is a list to resources i found helpful and would like to give credit to.

⬆️

Template inspired by othneildrew

About

Quick api to test and discover how redis works. For best portability i added docker.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published