https://github.com/whoisaditya/golang-task
REST API for User Authentication and Data Storage
https://github.com/whoisaditya/golang-task
gin-gonic golang gorm jwt mongodb
Last synced: about 2 months ago
JSON representation
REST API for User Authentication and Data Storage
- Host: GitHub
- URL: https://github.com/whoisaditya/golang-task
- Owner: whoisaditya
- License: mit
- Created: 2023-05-24T19:40:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-24T18:44:22.000Z (almost 3 years ago)
- Last Synced: 2025-01-26T09:42:28.576Z (over 1 year ago)
- Topics: gin-gonic, golang, gorm, jwt, mongodb
- Language: Go
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang Task - REST API for User Authentication and Data Storage
This is a Golang-based REST API project that provides user authentication using email and password, and allows authenticated users to store their personal details. The API uses JWT (JSON Web Token) for secure authentication.
## Features
1. **User Authentication** (`/login`):
- Endpoint to authenticate users using their email and password.
- Returns a JWT token upon successful authentication.
2. **User Registration** (`/signup`):
- Endpoint to create a new user account.
- Stores user details like name, email, and phone in the database.
3. **User Data Storage** (`/addDetails`):
- Authenticated route that allows users to add their personal details.
4. **Health Check** (`/`):
- Simple endpoint to check if the backend server is up and running.
## Getting Started
Follow these steps to set up the project locally:
1. **Prerequisites**:
- Install Golang on your machine: [Golang Installation Guide](https://golang.org/doc/install)
- Install any required dependencies.
2. **Clone the Repository**:
```
git clone https://github.com/whoisaditya/golang-task.git
cd golang-task
```
3. **Environment Variables**:
- Create a `.env` file based on the `.env.example` file and set your environment variables, including database credentials, JWT secret, etc.
4. **Database Setup**:
- Set up the required PostgreSQL database and update the database credentials in the `.env` file.
5. **Run the Application**:
```
go run main.go
```
6. **Testing the Endpoints**:
- You can now test the API endpoints using tools like `curl`, `Postman`, or `Insomnia`.
- The base URL for the API would be `http://localhost:/`, where `` is the port number specified in your `.env` file.
## API Endpoints
1. **Health Check**:
- `GET /`
- This endpoint is used to verify if the server is up and running.
2. **User Registration**:
- `POST /signup`
- Request Body: `{ "name": "John Doe", "email": "john@example.com", "password": "your_password", "phone": "1234567890" }`
- Creates a new user account and stores the provided user details in the database.
3. **User Authentication**:
- `POST /login`
- Request Body: `{ "email": "john@example.com", "password": "your_password" }`
- Authenticates the user using the provided email and password.
- Returns a JWT token upon successful authentication.
4. **User Data Storage**:
- `POST /addDetails`
- Request Headers: `{ "Authorization": "Bearer YOUR_JWT_TOKEN" }`
- Request Body: Accepts various user details.
- Stores the provided user data for the authenticated user.
## Security Considerations
- The API uses JWT for authentication, ensuring that only authenticated users can access the `/addDetails` route.
- Passwords are securely hashed before storing them in the database to protect user information.
## Documentation
Refer to the [postman documentation](https://documenter.getpostman.com/view/16151723/2s93m7V1VV)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
With :heart: by Aditya Mitra