Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maria-v-ch/user_directory_demo
Web application for managing a list of users. The application implements the functionality for creating, editing, deleting and viewing users. It also provides user registration and authorization, access rights management, deployment using Docker, web server setup, database and security.
https://github.com/maria-v-ch/user_directory_demo
Last synced: 1 day ago
JSON representation
Web application for managing a list of users. The application implements the functionality for creating, editing, deleting and viewing users. It also provides user registration and authorization, access rights management, deployment using Docker, web server setup, database and security.
- Host: GitHub
- URL: https://github.com/maria-v-ch/user_directory_demo
- Owner: maria-v-ch
- Created: 2024-10-12T13:27:59.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-18T21:14:29.000Z (29 days ago)
- Last Synced: 2024-10-19T07:57:48.708Z (28 days ago)
- Language: Python
- Size: 92.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# User Directory Demo
User Directory Demo is a web application for managing a list of users. The application implements functionality for creating, editing, deleting, and viewing users. It also provides user registration and authorization, access rights management, deployment using Docker, web server setup, database integration, and security features.
## Live Demo
You can try out the User Directory Demo at: [https://paragoni.space](https://paragoni.space)
Feel free to explore the features and functionality of the application on this live demo site.
## Features
- User registration and authentication
- User profile management (create, read, update, delete)
- Role-based access control
- RESTful API with JWT authentication
- Swagger/OpenAPI documentation
- Prometheus monitoring integration
- Grafana dashboard for visualizing metrics
- Docker containerization for easy deployment
- Nginx as a reverse proxy
- PostgreSQL database
- Continuous Integration and Deployment with GitHub Actions
- Dynamic color palette for a unique visual experience
- Comprehensive logging system with rotation and separate error logs
## Technologies Used
- Python 3.9
- Django 5.1.2
- Django Rest Framework
- Simple JWT for authentication
- drf-yasg for API documentation
- Prometheus for monitoring
- Grafana for metrics visualization
- Docker and Docker Compose
- Nginx
- PostgreSQL 13
- Gunicorn as the WSGI HTTP Server
- GitHub Actions for CI/CD
- JavaScript for dynamic styling
- Python's built-in logging module for application logging
## Project Architecture
This project follows a standard Django MVT (Model-View-Template) architecture with the following enhancements:
- Uses Django's built-in ORM for database operations
- Implements RESTful API using Django Rest Framework
- Utilizes class-based views for better code organization
- Employs custom user model for extended user attributes
- Integrates Prometheus for application monitoring
- Uses Docker for containerization and easy deployment
- Implements CI/CD pipeline using GitHub Actions
- Implements a robust logging system with different log levels and file rotation
- Separates debug logs and error logs into different files for easier troubleshooting
## Dynamic Color Palette
One of the unique features of this application is its constantly changing color palette. Each time a user visits the site or navigates between pages, the color scheme of various elements is dynamically updated. This creates a fresh and engaging visual experience for users, making each interaction with the application unique.
The color changes are implemented using JavaScript, which assigns random colors from a predefined palette to different elements on the page. This feature demonstrates the application's modern, interactive design approach.
## Installation and Setup
1. Clone the repository:
```
git clone https://github.com/your-username/user-directory-demo.git
cd user-directory-demo
```
2. Copy the `.env.sample` file to `.env` and update the environment variables:
```
cp .env.sample .env
```
3. Build and run the Docker containers:
```
docker-compose up --build
```
4. The application should now be running at `http://localhost:8080`
## Running Tests
To run the tests, use the following command:
```
docker-compose run web python manage.py test
```
## API Documentation
API documentation is available at `/swagger/` and `/redoc/` endpoints when the server is running.
## Monitoring
- Prometheus is available at `http://localhost:9093`
- Grafana is available at `http://localhost:3000`
## Continuous Integration and Deployment
This project uses GitHub Actions for CI/CD. The workflow includes:
- Automated testing on push and pull requests
- Building and pushing Docker images to a registry
- Deploying to the production environment on successful merges to the main branch
You can view the CI/CD configuration in the `.github/workflows` directory.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Logging
This project implements a comprehensive logging system:
- Debug and general logs are stored in `logs/debug.log`
- Error and critical logs are stored in `logs/error.log`
- Log files are rotated when they reach 5 MB, with a backup count of 5
- Console logging is also implemented for immediate feedback during development
Logs are crucial for monitoring the application's behavior and quickly identifying issues in production.