lunatech-labs/lunatech-teahub

lunatech-teahub's Issues

Checking the merge requests

There are two merge requests open. One from Mahya for adding cache to the controller. Second one from Dimitris and Jose for connecting TEAHub to Github. These needs to be reviewed and merged .

Add Apache License

Core Framework

Add a skeleton for the project.
We are using play framework with Compile time DI.

The previous project Written by Jose has been deleted. We need a new template to start fresh.

Creating Front End Mockup

Implement the front-end of the project. Something simple that just have the links between the pages without any functionality. We are going to use bootstrap.

Investigation about OAuth

What type of Authorisation does exist? How does it work? which one should we use.

Using Travis for CI

We have decided to use Travis for CI. It needs to be configured and figured how to use.

Implementation of sign in/ sign up flow through Github

Implementing a page for TEAHub with a sign up button:
When user clicks on sign up, it should open a new tab and goes to the Github page which asks Github credentials. After logging in to Github, they will inform the user that TEAHub wants to have access to some information. After User authorised the action it should come back to TEAHub page and shows the welcome page on TEAHub.
The flow for Sign in would be the same:
If user click on Sign in, TEAHub goes to Github get the information and shows the Welcome page. For this flow, what user sees is only sign in page of TEAHub and then Welcome page of TEAHub.

These two flow can be done with only one button sign in/sign up. Or it can have two separate buttons.

Investigation about monitoring

We might need monitoring about how many instances of our application is running, or some monitoring about the server, etc.
An investigation is needed for the techniques that we can use. Some options could be: Kamon, or newrelic, etc.

Investigation about CI and test coverage

There are plenty of options for CI, some of them gives the ability for the test coverage too. For instance: Bamboo, CircleCI, TeamCity, etc. Right now our first suggestion for CI is Travis. However, Travis does not have the option for test coverage.
An investigation is needed in this area to know what is the best option.

Connecting Github action functionality to the front end

Jose and Dimitris implemented an action which allows users to sign in in TEAHub via Github. This action needs to be connected to the front end.
Acceptance criteria:
1- We have the first 2 steps of the logging in completed, meaning:
*User click on the login button and redirects to the Github page.
*After users comes back from the Github page goes to the proper page in TEAHub.
2-Github returns a list of repositories of the user. This list needs to be handled and be shown in a proper page.

Connecting Toggl functionality to the front end.

Mahya wrote an action that takes the list of projects from Toggl. This function needs the workspace id of the user. In order to have the work space id we should send another request to Toggl. This id now is shown by xxx in ApiTogglService.
Acceptance criteria:
1- Write a n action to get workspace id from Toggl. User does not need to know about this action.
2- Connect the current action 'togglProjects' to the front end so user can see the list of the projects.

There are documents available from Toggl API that explains all the request and responses to Toggl

Investigating about Toggle Api

The hours that are spend per project needed to add in Toggle via Toggle webpage. In TEAHub, per project we are going to have estimation time and real spend time. The spending time needed to be loaded from Toggle. Therefore, we need to know how does Toggle Api works and what kind of information it gives us. For instance does it also return the bill info along with the hours?

Investigating about deployment options

Come up with the best solution for deployment based on our application needs. Some suggestion could be: CleverCloud, DigitalOcean, etc.

Implementation of accessing to the Toggl projects

Implementation of a page in TEAHUb after Welcome page, in order to access list of project in Toggl:
We need a page that asks Toggl API token from user. The User needs to go to Toggl -> my profile -> copy API token and paste it in TEAHub page. We need a box in that page that user can paste the API token( It would be nice to have a small instruction for user that where can they find the API token). Then we need a button in that page to fetch the information from Toggl. clicking on that should return the list of projects that user has in his/her Toggl.

Add scalariform to the project

This plugin is used for source code formatting. More information can be find here

Use session instead of cache

Right now in the controllers we are using cache to save some properties such as apiToken and authToken. This needs to be change in a way that we use session instead of cache.

Investigating about FrontEnd Tech

Investigate about what technology can be use for the frontend and come up with a proposal.

DataBase structure

We decided to use doobie for the DB. We need to come up with a data model for the DB.

Add DataBase

In order to keep the information such as toggl token api, list of project, etc, we need to add DB. @mjwh has already done some work on the DB. Talk with him about what he has done. There is also a closed issue about it.
Take a look at defined data model