Welcome to the User Microservice project! This project is built using the Go programming language and is designed to manage user roles and access through APIs. It utilizes JWT token authentication for validating users and MongoDB for database management, along with Redis for caching authentication and session management.
The User Microservice project supports the following user roles:
- Guest: Users who are not logged in or authenticated.
- Buyer: Users who have registered as buyers and have access to specific buyer functionalities.
- Supplier: Users who have registered as suppliers and have access to supplier-specific functionalities.
- Admin: Users with administrative privileges, granting them access to manage users, roles, and other administrative tasks.
For detailed information on the APIs provided by the User Microservice, please refer to the API documentation.
To get started with using the User Microservice project, follow these steps:
-
Clone the repository:
git clone https://github.com/MicroMasters/user-service.git
-
Install dependencies:
cd user-service go mod download
-
Set up MongoDB and Redis:
Ensure you have MongoDB and Redis installed and running on your system. Update the configuration file (
config.yaml
) with your MongoDB and Redis connection details. -
Build and run the project:
go build ./user-service
-
Access the APIs:
Once the service is up and running, you can access the APIs using the provided endpoints as documented in the API documentation.
We welcome contributions to the User Microservice project! Feel free to fork the repository, make changes, and submit pull requests.
If you encounter any issues or have suggestions for improvements, please open an issue on the issue tracker.
This project is licensed under the MIT License. Feel free to use, modify, and distribute it as per the terms of the license.
Developed by MicroMasters