WeAppe.ar

Open source time logger backend made in Dart
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Setting up the project
   • Deploying
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

There are many time trackers in the market that can let you log your hours to projects, but the main problematic behind them is that after the project manager take you out of the project you can't view or see your time logs anymore, so therefore you can't demonstrate the hours you worked.

(back to top)

Built With

• Dart
• Alfred Package

(back to top)

Getting Started

Prerequisites

You need to have installed at least the version 2.17.0 of Dart.

• Dart SDK installation guide

Setting up the project

1. Clone the repo

   git clone https://github.com/tomassasovsky/WeAppe.ar.git

2. Install Pub packages

   flutter pub get

3. Configure the .env file

   MONGO_CONNECTION=your_mongo_connection_string
   JWT_REFRESH_TOKEN_SIGNATURE=your_jwt_refresh_token_signature
   JWT_ACCESS_TOKEN_SIGNATURE=your_jwt_access_token_signature
   IMGUR_CLIENT_ID=your_client_id_for_IMGUR
   INVITE_EMAIL_ACCOUNT=your_email_address_for_invite_email@mail.com
   INVITE_EMAIL_PASSWORD=email_address_password
   INVITE_EMAIL_HOST=the_host_of_your_email_address (e.g. smtp.gmail.com)
   INVITE_EMAIL_PORT=the_port_of_your_email_address (e.g. 465)
   INVITE_EMAIL_USER_NAME=The Name You Want To Use For The Email Address (e.g. Alfred Server)
   HOST=where_you_want_to_host_the_server (e.g. http://localhost:8080)

Deploying

This is our recomendation to deploy this backend, know that there are problably some other ways to make your project go live.

1. Create a new project in Google Cloud Run. Here is the documentation on how to.

2. Install the gcloud CLI https://cloud.google.com/sdk/docs/install.

3. Go to the Google Cloud Console API and create a project. Note the project id, something like weappear-test.

4. Run gcloud auth login to authenticate with google cloud as the documentation says.

5. Run the next the command to deploy it:

   gcloud beta run deploy weappearbackend --source . --allow-unauthenticated --project=[PROJECT_ID, in this case, weappear-test]

6. To set-up the enviroment variables enter to your running Google Cloud Run project and click on "Edit and deploy a new revision".

7. Go to your variables and secrets tab, and fill out everything from the .env file.

(back to top)

Endpoints and Usage

We have an active Postman Workspace with all the endpoints and responses updated where you can check the behavior of the backend to implement it.

(back to top)

Roadmap

Testing

• 100% test coverage

Features

• User Login
• Register with account activation via email.
• Create entities to clock in/out to
• Join entities to clock in/out to
• Clock in/out to entities
• Picture upload to Imgur
• Task creation/asignation for clock ins/outs
• Clock in/out pagination
• 2 Factor Authentication

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature-name)
3. Commit your Changes (git commit -m 'Add some amazing-feature')
4. Push to the Branch (git push origin feat/amazing-feature-name)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Tomás Sasovsky - @tomaSasovsky - [email protected]

Nazareno Cavazzon - @NCavazzon - [email protected]

Jorge Rincon Arias - @JorgeR5 - [email protected]

Project Link: https://github.com/tomassasovsky/WeAppe.ar

(back to top)