Skip to content

Commit 5135b94

Browse files
authored
Create README.md
1 parent 697225a commit 5135b94

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
Spam Classifier App
2+
===================
3+
4+
This is a Spam Classifier app that uses Python, Angular for the frontend, and Spring Boot on the backend to classify emails as either spam or not spam.
5+
6+
Getting Started
7+
---------------
8+
9+
To get started with this app, you will need to have Docker installed on your local machine. You can download and install Docker from [here](https://www.docker.com/products/docker-desktop).
10+
11+
Once you have Docker installed, you can follow the instructions below to run the app.
12+
13+
### Running the App
14+
15+
To run the app, you will need to run the following commands in your terminal:
16+
17+
`./install.sh`
18+
19+
This will start the Docker containers for the frontend, backend, and database of the app.
20+
21+
Once the containers are up and running, you can access the app in your web browser at [http://localhost:80](http://localhost:80).
22+
23+
Frontend
24+
--------
25+
26+
The frontend of this app is built using Angular. It provides a simple user interface where users can enter an email message and classify it as spam or not spam.
27+
28+
Backend
29+
-------
30+
31+
The backend of this app is built using Spring Boot. It provides a RESTful API for the frontend to communicate with and handles the classification of emails as either spam or not spam.
32+
33+
Uninstalling the App
34+
--------------------
35+
36+
To uninstall the Spam Classifier app, you can run the following command in your terminal:
37+
38+
`./uninstall.sh`
39+
40+
License
41+
-------
42+
43+
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
44+
45+
Authors
46+
-------
47+
-   [Drin Karkini](https://github.com/ComputerGeek5)
48+
49+
-   [Jon Mukaj](https://github.com/jonmukaj)
50+
51+
-   [Kevin Tenolli](https://github.com/ProfessorGustavi)

0 commit comments

Comments
 (0)