https://github.com/ademcatamak/passingnotes
Go Web Api in DevContainer / Deploy via Shell
https://github.com/ademcatamak/passingnotes
Last synced: 4 months ago
JSON representation
Go Web Api in DevContainer / Deploy via Shell
- Host: GitHub
- URL: https://github.com/ademcatamak/passingnotes
- Owner: AdemCatamak
- Created: 2024-08-06T21:03:13.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-24T15:15:29.000Z (about 1 year ago)
- Last Synced: 2025-05-24T06:36:51.451Z (5 months ago)
- Language: Shell
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# Passing Notes
## Overview
This project is a simple, passing notes application built using Go. It leverages Redis as a data storage backend and is containerized using Docker for easy deployment and testing. The application provides a RESTful API with two primary endpoints:
* _**POST /api/notes**_ Accepts a text message as input and stores it in Redis for a maximum of 5 minutes.
* _**DELETE /api/notes/:id**_ Searches for a note based on a provided key. If found, the note is returned to the user and then deleted from Redis. This ensures a one-time read message system.
Also, a screen like the one below can be accessible with **"/"** and **"/index"**. Via this screen, requests can be sent to the two endpoints mentioned above.
## Run Application
### DevContainer (Recommended)
If you choose this method, you will need:
- Docker
- An IDE that supports DevContainers (e.g., VS Code, GoLand)
Upon launching the DevContainer, a Redis instance will be provisioned. The Redis connection string will be stored as an Environment Variable. This ensures a smooth connection when you run the application. The DevContainer will redirect incoming requests on port 8080 of your local machine to port 80 within the container. This is the port where your application is configured to listen.
### Local Execution
If you choose this method, you'll need:
- Go 1.22 or later version
- Redis instance
- An IDE that you love
You need to create an .env file in the root directory of the project. Inside this file, you need to place the connection string for your Redis instance in the REDIS_HOST key and the corresponding value.
Sample Value:
```
REDIS_HOST=localhost:6379
```
Once you've made these changes, you can compile and run your Go project using your preferred build tool or IDE. This could involve using commands like go run main.go or go build followed by executing the generated binary.