aryamanz29 / elastic-cfc

A Logs analyzer for developers builds on top of elastic search. 📜⚡

 

elastic-cfc's Issues

Add linters and formatters for the code

Add linters and formatters with github workflow so that consistency will be maintained

IMPROVE README

PROJECT WORKFLOW 🧑‍💻

Getting Started 👇

• Java SE Dev Kit Download here: https://www.oracle.com/java/technologies/javase-jdk16-downloads.html
• Elastic Search Download: https://www.elastic.co/downloads/elasticsearch
• Configuration: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-elasticsearch-on-ubuntu-18-04
• Django Elasticsearch DSL is a package that allows indexing of Django models in elastic search : https://github.com/django-es/django-elasticsearch-dsl

Dockerize this project

• Dockerize this project
• Update README.md as per change

Feature : Improvement of `Frontend UI`

Improvement of React UI Code

API'S FOR PROJECT

Need Rest API's

• To upload logs (GET,POST)
• To View 'N' lines of recent uploaded Log (GET)
• To Search query and Give Result (GET)

QA : Add Issue and PR template

• Add Issue and PR template to the repo
  @blackphoenix42 Please look at this issue and add those files
  For Reference, Check this out: https://github.com/girlscript/winter-of-contributing/tree/main/.github

Add `.gitignore` file for the project

Add .gitignore file to unstage unwanted files like pycache etc..

GENERAL IDEA LIST FOR PROJECT 👨‍💻 :

GENERAL IDEA LIST FOR PROJECT 👨‍💻 (Open for discussion) 🤔

• UI: Frontend UI improvement.
• Dockerize: Django back-end and react frontend.
• Feature : Logs searching/filtering result to clients via e-mail/text messages.
• Feature : Save results in .csv/pdf/excel format.
• Feature : User authentication & authorization.
• CI/CD : using GitHub actions.
• Docs: Docs Improvements.
• Feature : Add support for different types of log files.
• Feature : Add various Rest API endpoint for various logs filtering computations.
• Tests : API documentation and testing.

NOTE : Before start working on above Idea-list, I would highly recommend you to run this project locally and try to upload & search query on sample-log file present in root directory of the project.

Add Log Detail API

Add log detail API to return some log lines to the frontend

Docs : Add `CODE_OF_CONDUCT.md` & `CONTRIBUTING_GUIDELINES.md`

• @blackphoenix42 : Add CODE_OF_CONDUCT.md & CONTRIBUTING_GUIDELINES.md to the project

bug: Fix corsheaders issue

Add React Frontend Code for logs file upload

Tasks:

1. Create a folder frontend in project root diretory.
2. Add all the code related to frontend here. We are using react for this.
3. Add source code in src directory
4. create a form for logs upload in react with a loader.

Feature : Create a user `Login` & `Signup`

For sending an email/text to a user about the search/filtering of logs we need to first create a user model in the app

I will create a user authentication feature in the webapp for users to signup and keep the data of their logs . @Aryamanz29 please assign me this issue .
I'm a participant of GSSoC'22

Create API for logs upload

tasks:

1. Create serializers and models
2. Create postview for this upload and saving the detail to Database.
3. Write a Get View for the same.

Feature : Creating a user Login/Signup feature

I would like to add a user Login/Signup feature for this website