https://github.com/mathsqrt2/rejewski
https://github.com/mathsqrt2/rejewski
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mathsqrt2/rejewski
- Owner: Mathsqrt2
- Created: 2025-02-11T21:02:34.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-03-06T18:25:21.000Z (3 months ago)
- Last Synced: 2025-03-06T18:33:09.678Z (3 months ago)
- Language: TypeScript
- Size: 243 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rejewski
### About
A dedicated Discord bot for automating server management in the scientific community of the [Opole University of Technology](https://po.edu.pl/). It fully respects the protection of personal and sensitive data while verifying users’ affiliation with the university, ensuring efficient and secure server operations.
---
### The Name "Rejewski"
[Marian Adam Rejewski](https://en.wikipedia.org/wiki/Marian_Rejewski) (1905–1980) was a Polish mathematician and cryptologist who, in 1932, cracked the Enigma cipher used by Nazi Germany. His success enabled the British to decode German military communications during World War II, significantly contributing to the Allies’ victory.
---
### Technologies Used
- [**NestJS:**]() – A modular framework for building efficient, scalable [Node.js](http://nodejs.org/) applications
- [**TypeScript:**](https://www.typescriptlang.org/) – The main programming language for the bot
- [**DiscordJS:**](https://discord.js.org/) – A robust library for interfacing with the Discord API
- [**MySql:**](https://www.mysql.com/) A widely-used open-source relational database management system known for its reliability and scalability.
- [**TypeOrm:**](https://typeorm.io/) An ORM for TypeScript and JavaScript that supports various databases, providing tools for object-relational mapping.
- [**Docker**](https://www.docker.com/) – A containerization platform that simplifies deployment and environment consistency
---
### Getting started
Clone the repository
```bash
git clone https://github.com/Mathsqrt2/RedirectionPanel.git
```
To run the application, you'll need a [.env](.env.example) file where you fill in the basic information required for the bot to function.
Then run the panel
```bash
npm run start
```