user-management/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2024-05-25 21:55:03 +02:00
# User Management System [![License](https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
2024-05-25 20:14:01 +02:00
This project provides a system for managing users, including adding, listing, finding, and deleting users.
## Prerequisites
Before running the project, make sure you have the following installed:
- [Haskell Stack](https://docs.haskellstack.org/en/stable/README/): a tool for managing Haskell projects
- [SQLite](https://www.sqlite.org/index.html): a lightweight database system
## Getting Started
2024-05-25 20:27:29 +02:00
1. Clone the repository: `git clone https://git.wmi.amu.edu.pl/s475286/user-management.git`
2024-05-25 20:14:01 +02:00
2. Navigate to the project directory: `cd user-management`
3. Build the project: `stack build`
4. Run the application: `stack exec user-management-exe`
## Usage
The application provides the following commands:
- `add-user <name> <email> <password>`: adds a new user to the database
- `list-users`: lists all users in the database
- `find-user <name or email>`: finds users with a matching name or email
- `delete-user <name>`: deletes a user from the database
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
## License
2024-05-25 22:06:49 +02:00
This project is licensed under the [CC BY-NC-SA 4.0](LICENSE.MD).