y1220 / Sentiment-dc

portable platform to track sentiment runs on docker

Project description

Aiming for making a platform for software developers to visualize their task statuses,
objective goal is to improve the approachability of collaboration inside of teams.
By selecting characteristics of the task, it searches similar tasks from the history and it provides you with a description about the task, commit history.
It utilises GitHub API, ClickUp API, information can be fetched or updated via our UI.
Also, by storing information about daily task status and your availability to help teammates,
it suggests to whom you need to help, to whom you can ask help if you need.

Future focuses are to implement the ML algorithms to obtain the analysis functionarities below.

• evaluation of the task characteristics
• list up the skill set, seniority of developers
• help matching based on needs, skills
• similarity calculation of tasks
• counting the visits of forum content, eventually used for analysis of content preferences, seniority level of developer
• comparison of time used depends on week/month wise according to the needs
• utilize Notion API to store and share the updated data among the team
  tutorial of Notion API - databases
• organize the accessible comments list regarding the code snippets
  documentation about GitHub link generation

Ruby version

2.5

Prerequisites (Linux)

sudo chown -R 5050:5050 <PGADMIN_VOLUME_HOSTPATH>

Utilities Scripts (Linux)

Check the .local folder in the project root. It contains utilities scripts in order to develop and setup your local environment.

Docker command for setup

docker-compose up -d
docker-compose exec web bash
bundle install
rails db:create
rails db:migrate

Docker command for running server

rails s -b 0.0.0.0

Database creation

(option 1): run a seed file rails db:seed

(option 2): operate from console rails c Model.create(name: 'something'...)

Database management

tutorial for connecting to pgadmin

Test

To be implemented in near future

How to use

(Pre-requirements)

- register ClickUp workspace, obtain your API token
- prepare github repository, look for your repository id

(Procedure to use the platform)

1. fron Welcome page, register your ClickUp keys and values
   

@@ key: value @@
Authorization: API token
team_id: int(8)
tasks_space_id: int(8)
availabilities_list_id: int(8)
gitbranch_field_id: string(36)

2. likewise above, register your GitHub keys and values
   

repo_name: your repository name
username: username of repository owner

3. from Tasks page, update task data

which creates records of tasks, branches, and users on ClickUp<br/>

4. from Commits page, update commit data
   

which instead, creates records of commits related to the branch registered in our db
- please update commit before you merge the branch into different branch, otherwise the commit may be taken as wrong branch's ones