Checkit Enron Email Search App

Introduction

Welcome to the Enron Email Search App repository! This project provides a simple and intuitive way to explore the Enron Email Dataset, offering users the ability to browse and search through the extensive collection of emails from the Enron Corporation.

About the Project

This app was developed to allow users to delve into the Enron emails, gaining insights into corporate communication and operations. The Enron Email Dataset was released to the public during the legal investigation following the Enron scandal, making it a valuable resource for research and education.

Project Structure

The project is divided into three main parts:

Frontend: Built with Vue.js and TailwindCSS, the frontend provides a clean and responsive user interface for browsing and searching emails.
Backend: Developed using Go and Chi, the backend handles API requests and manages communication between the frontend and the ZincSearch database.
Indexer: Also written in Go, the indexer processes and indexes the Enron email data into ZincSearch.

Features

Simple User Interface: An easy-to-use UI for browsing the emails.
Search Engine: A powerful search engine to help users find specific concepts and topics of interest.

Getting Started

Prerequisites

To run this project, you will need:

Go 1.18 or higher
ZincSearch
Other dependencies listed in go.mod and package.json
Node.js and npm
Vue
Docker
Chi

Installation

Clone this repository to your local machine:

git clone https://github.com/davidsequera/checkit.git

Navigate to the project directory:
```
cd checkit
```

Backend

Install the required Go modules:
```
cd backend
go mod tidy
```
Set up ZincSearch:
- A simple docker container.
- Start the ZincSearch service.
Index the Enron email data into ZincSearch:
```
go run cmd/indexer/main.go
```
Run the backend server:
```
go run cmd/server/main.go
```

Frontend

Navigate to the frontend directory:
```
cd ../frontend
```
Install the required npm packages:
```
npm install
```
Run the frontend development server:
```
npm run dev
```

Profiling

go tool pprof -http=":8000" pprofbin ./cpu.prof

Usage

Once the app is running, you can access it via your web browser at http://127.0.0.1:8080 for the frontend. Use the UI to browse emails or utilize the search feature to find specific content.

Contributing

We welcome contributions! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

Fork the repository.
Create a new branch:
```
git checkout -b feature/YourFeature
```
Make your changes and commit them:
```
git commit -m 'Add some feature'
```
Push to the branch:
```
git push origin feature/YourFeature
```
Create a new pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

Enron Email Dataset provided by Carnegie Mellon University.
Inspiration and guidance from the open-source community.

Contact

For any questions or inquiries, please open an issue in the repository or contact us at davidsequera.bs@gmail.com.

We hope you find this app useful for exploring the Enron emails. Happy searching!