{"info":{"_postman_id":"e2a9f5db-88cd-4f4f-bef6-a6b97315f438","name":"Event management API - Go","description":"

Go-Server Project

\n $\"Go$ \n\n

Overview

The Go-Server project is a simple web application built with Go, utilizing the Gin framework for routing, and PostgreSQL as the database. This project demonstrates the core principles of building and deploying a RESTful API with JWT authentication, focusing on managing events and user registration.

Features

User Authentication: Secure login and signup functionality with JWT tokens.
\n
Event Management: Create, retrieve, update, and delete events.
\n
User Event Registration: Register and unregister for events.
\n
Dockerized Deployment: Easy deployment using Docker and Docker Compose.
\n

Core Technologies

Programming Language: Go
\n
Framework: Gin
\n
Database: PostgreSQL
\n
Authentication: JWT (JSON Web Tokens)
\n
Containerization: Docker
\n

Endpoints

Event Routes

GET /events
\n
- Fetch all events.
\n
GET /events/:id
\n
- Fetch a specific event by ID.
\n
POST /events
\n
- Create a new event (requires authentication).
\n
PUT /events/:id
\n
- Update an event by ID (requires authentication).
\n
DELETE /events/:id
\n
- Delete an event by ID (requires authentication).
\n
POST /register
\n
- Register for an event (requires authentication).
\n
POST /unregister
\n
- Unregister from an event (requires authentication).
\n

User Routes

POST /signup
\n
- Create a new user account.
\n
POST /login
\n
- Authenticate and log in to receive a JWT token.
\n

Setup and Installation

Prerequisites

Docker installed on your machine
\n
Docker Compose installed
\n

Running the Application

git clone https://github.com/tejasvi541/Go-Server.gitcd Go-Server
\n
docker-compose up --build
\n
The server will run on http://localhost:8080.
\n
- Use tools like Postman or curl to interact with the endpoints.
  \n
- Ensure to include the JWT token in the Authorization header for routes that require authentication.
  \n
\n

Docker Image

The Docker image for this project can be found on Docker Hub.

Environment Variables

You can configure the following environment variables in the .env file:

DB_HOST: Database host (default is localhost)
\n
DB_PORT: Database port (default is 5432)
\n
DB_USER: Database username (default is postgres)
\n
DB_PASSWORD: Database password
\n
DB_NAME: Database name (default is events)
\n
JWT_SECRET: Secret key for JWT tokens
\n

Contributing

Contributions are welcome! Please fork the repository and create a pull request to contribute to this project.

License

This project is licensed under the MIT License.

Happy coding! 🎉

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Go-Server Project","slug":"go-server-project"}],"owner":"13991317","collectionId":"e2a9f5db-88cd-4f4f-bef6-a6b97315f438","publishedId":"2sA3sAhnX1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-20T20:15:00.000Z"},"item":[{"name":"Events","item":[{"name":"Create event","id":"ed821b83-ef45-4574-8ec6-a90338bd3161","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImhlbGxvMTFAZ21haWwuY29tIiwiZXhwIjoxNzI0MjY3MzI3LCJ1c2VySWQiOjZ9.JHG4smP4kNyItZaWBoX4QMBno_6WT8N5NvGJso2dyug","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"Bomb Event 2\",\n \"description\":\"Make Bomb\",\n \"location\":\"Hiroshima\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"http://localhost:8080/events","description":"

Create a new event.

\n","urlObject":{"path":["events"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"e37a4685-a4d1-46d3-bdc7-c4445a8cb910","name":"Event created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Postman Galaxy\",\n \"date\": \"2021-02-2\",\n \"time\": \"00:00:00\",\n \"location\": \"Online\",\n \"description\": \"Postman Galaxy API conference\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"http://localhost:8080/events"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"eventId\": \"abc-123\",\n \"name\": \"Postman Galaxy\",\n \"date\": \"2021-02-02\",\n \"time\": \"00:00:00\",\n \"location\": \"Online\",\n \"description\": \"Postman Galaxy API conference\"\n}"}],"_postman_id":"ed821b83-ef45-4574-8ec6-a90338bd3161"},{"name":"List events","id":"2cc3efd0-7af0-4171-ad85-462a3bcf1ee4","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:8080/events","description":"

List all upcoming events.

\n","urlObject":{"path":["events"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"b26f2560-2312-476b-9ed8-400529a63c80","name":"Events retrieved successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:8080/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"eventId\": \"abc-123\",\n \"name\": \"Postman Galaxy\",\n \"date\": \"2021-02-2\",\n \"time\": \"00:00:00\",\n \"location\": \"Online\",\n \"description\": \"Postman Galaxy API conference\"\n },\n {\n \"eventId\": \"def-456\",\n \"name\": \"FOSDEM 2023\",\n \"date\": \"2023-02-04\",\n \"time\": \"12:00:00\",\n \"location\": \"Brussels\",\n \"description\": \"A free event for software developers to meet, share ideas and collaborate.\"\n }\n]"}],"_postman_id":"2cc3efd0-7af0-4171-ad85-462a3bcf1ee4"},{"name":"Get event details","id":"59d966ba-4e22-4c94-9b5b-4b52b2ead1e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:8080/events/:eventId","description":"

View details of an event, including the number of registered attendees. For full attendee information, the \"List attendees\" endpoint can be used.

\n","urlObject":{"path":["events",":eventId"],"host":["http://localhost:8080"],"query":[],"variable":[{"type":"any","value":"2","key":"eventId"}]}},"response":[{"id":"befc4415-a266-456e-a559-eae0cb4fe9a6","name":"Event retrieved successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"http://localhost:8080/events/:eventId","host":["http://localhost:8080"],"path":["events",":eventId"],"variable":[{"key":"eventId","value":"abc-123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"eventId\": \"abc-123\",\n \"name\": \"Postman Galaxy\",\n \"date\": \"2021-02-2\",\n \"time\": \"00:00:00\",\n \"location\": \"Online\",\n \"description\": \"Postman Galaxy API conference\",\n \"attendees\": 127\n}"}],"_postman_id":"59d966ba-4e22-4c94-9b5b-4b52b2ead1e2"},{"name":"Update event","id":"8a884e79-4545-4799-90cc-77a22b5c9669","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\":\"Bomb Event 4\",\n \"description\":\"Rebuild Bomb\",\n \"location\":\"Nagasaki\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"http://localhost:8080/events/:eventId","description":"

Update the details of an existing event by ID.

\n","urlObject":{"path":["events",":eventId"],"host":["http://localhost:8080"],"query":[],"variable":[{"type":"any","value":"1","key":"eventId"}]}},"response":[{"id":"bb3da9c5-f4ae-461c-9993-1d1fc1a3abb9","name":"Event updated successfully","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Postman Galaxy\",\n \"date\": \"2021-02-2\",\n \"time\": \"12:34:56\",\n \"location\": \"Online\",\n \"description\": \"Postman Galaxy API conference\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"http://localhost:8080/events/:eventId","host":["http://localhost:8080"],"path":["events",":eventId"],"variable":[{"key":"eventId","value":"abc-123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"eventId\": \"abc-123\",\n \"name\": \"Postman Galaxy\",\n \"date\": \"2021-02-2\",\n \"time\": \"12:34:56\",\n \"location\": \"Online\",\n \"description\": \"Postman Galaxy API conference\"\n}"}],"_postman_id":"8a884e79-4545-4799-90cc-77a22b5c9669"},{"name":"Delete event","id":"00ff5007-349e-410a-98c6-0f171226e4be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/events/:eventId","description":"

Delete an existing event.

This folder contains CRUD operations for events.

\n","_postman_id":"e00aaa4f-29e2-482a-b8b4-8a8f3fcf2712"},{"name":"User","item":[{"name":"SignUp User","id":"19467ef7-62e0-48ec-a9ff-be028b73998f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"tejasvi22\",\r\n \"email\":\"hello11@gmail.com\",\r\n \"password\":\"12345678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/signup","urlObject":{"path":["signup"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[],"_postman_id":"19467ef7-62e0-48ec-a9ff-be028b73998f"},{"name":"Login","id":"f4f09a18-6876-4e74-ae57-6acfa6694e0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"hello11@gmail.com\",\r\n \"password\":\"12345678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/login","urlObject":{"path":["login"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4f09a18-6876-4e74-ae57-6acfa6694e0d"}],"id":"ab6d41e0-6709-440f-839d-1a1795711ee5","_postman_id":"ab6d41e0-6709-440f-839d-1a1795711ee5","description":""}],"event":[{"listen":"prerequest","script":{"id":"0eac71da-c99c-4802-aee9-5cc7a081c592","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bbb8e91-2ef2-4487-a245-32e688d7cebb","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"http://localhost:8080"}]}