saeloun / miru-web

Miru | Time Tracking and Invoicing and Employee Benefits. Built using Ruby On Rails and ReactJS

Miru is an open-source tool, designed to make time tracking, invoice management, and accounting easy for small businesses worldwide. It is a platform for organizations to help them streamline their workflow.

---

Major Features

• 🕒 Time Tracking: Intuitive time tracking tools for effortless monitoring of work hours.

• 💼 Invoicing: Create professional invoices with ease, using time tracking data. Send invoices directly to clients via email for prompt payment processing.

• 👥 Team Page: Collaborative workspace to manage your team's work efficiently.

• 👤 Client Page: Centralized client management system for maintaining client information. Easily access client details when creating invoices or reports.

• 🏢 Client Portal: Access a client-specific dashboard for a quick overview of all invoices with update status.

• 🚀 Projects: Dashboard to add new projects, team members, and rates.

• 📊 Reports Page: Generate comprehensive reports for insights into project performance. View time tracking data, expenses, and revenue summaries. Export reports in various formats (PDF, CSV) for sharing or record-keeping.

• 💳 Integration with Payment Gateways: Seamlessly connect with STRIPE for quick and secure payments. Accept payments directly through Miru.so to streamline invoicing and payment processing.

Upcoming Features

• 💰 Expense Tracking: Keep track of project-related expenses and allocate them to clients or projects. Capture receipts and attach them to expense entries for documentation. Include expenses in invoices for transparent billing.

• 🌐 Multi-Platform Accessibility: Access Miru.so from web browsers, desktop applications, and mobile devices. Synchronize data across platforms for flexibility and convenience.

• 🏖️ PTO Module: A comprehensive leave management module.

• 📅 Google Integration: Integration to track and add meetings directly.

Documentation

For detailed information on how to use Miru Web and its various features, please refer to our official documentation:

Official Documentation

The documentation covers everything from installation and setup to advanced usage and troubleshooting. It's the best resource for getting started with Miru Web.

Community Support

• Feel free to join our Discord channel for support and questions.
• Subscribe to our latest blog articles and tutorials.
• Discussions: Post your questions regarding Miru Web
• Twitter

Contributing

We encourage everyone to contribute to Miru Web! Check out Contributing Guide for guidelines about how to proceed..

Note: We are working on improving the documentation. So we created a docusaurus app for documentation. Check out the Miru Docs.

Contributors ✨

Thanks goes to all our contributors

License

Miru © 2023, Saeloun - Released under the MIT License.

miru-web's Issues

Setup Heroku

Allow spaces in first and last name on signup/login page

Fix: Update Text Spacing to 1.6px in login/signup/password reset/password set page

In team page, 'Create new user' option should be available only for Admin and Owner

Add the visual designs for signup/login/forgot password pages.

https://www.figma.com/file/4gdPDRPqGqQqPYsO3Qj8CG/Miru-App?node-id=483%3A1452

Setup Devise and User model

1. Build a User model.
2. Use devise gem for creating the user model.
3. Add validation that first_name, last_name, and email and password is required field.
4. Add length validation(maximum: 50) for first_name and last_name field.
5. Add a unique index for email.
6. Add validation for verifying the email address.
7. Add length validation for the password (minimum: 6)
8. Add a not-null constraint to the email, first_name, and last_name column.
9. Add unit tests for User models that all the validations mentioned above are met.
10. Use minitest for writing test

Tailwind css not working on heroku

Bug: Tailwind CSS not working on Heroku, but it's working on local.

Sign up and sign in with Apple option

Develop the Team page

• Use Devise Invitable gem for user invitation https://github.com/scambra/devise_invitable

Build a user and API authentication mechanism.

We are using API style where the server (Rails) will primarily send data as JSON API and the client (React) will build the HTML. This is different from the "pure API" style. Here the frontend code and the backend code are in the same repository.
So all our communication happens through API. We need to authenticate each API request from React.

• Explore the best mechanism for implementing API authentication in react + rails.
• Implement the authentication mechanism in rails based on the findings.

Add role attribute to the User table

1. There are two roles: “admin” and “employee” (regular user).
2. The default role for a user would be “employee”.
3. Use enums for creating role attributes.

Develop the functionality for admin to be able to provide admin access to other employees

https://saeloun.notion.site/Give-Admin-Access-9619e997a709408cad64e793f6f1f2db

A user should be able to delete profile picture on profile settings page .

Setup SimpleCov code coverage

Ref: https://github.com/simplecov-ruby/simplecov

An admin user should be able to edit & delete a member details from team page.

• Admin User should able to edit a member details
• Admin user should be able to delete a member from the team

Note: Add a new field in User table "state", which should be an enum "active" and "inactive". We don't want to delete the user record completely from our database. For delete, we can just update the user state to inactive.

Basic mocks and designs based on Stake holders

Develop the UI for Sign In and Sign Up

https://www.figma.com/file/4gdPDRPqGqQqPYsO3Qj8CG/Miru-App?node-id=50%3A38

1. Convert Sign In and Sign Up design to Code

Configure the tailwind based on the themes

1. Setup tailwind.config.js
2. Add colour themes based on the miru wireframe design

Develop Logout functionality

https://saeloun.notion.site/Add-Logout-Screen-3dcba5fbb6ea4ac5af6f886b3f18345c

Add the forgot password backend functionality

Clients page (2/X) - New Client button, Match visual design with Figma

Refer #77

Enable heroku review apps

Unable to login after forgot password flow

Develop functionality for organization setup

https://saeloun.notion.site/Add-Organization-Setup-69872b4f80e4476fbd72ae0388bb20c8

Setup Github Action

1. Reference: https://medium.com/@OwenTran/github-workflow-for-rails-ci-34209a53d19e
2. Should Include Validation for Rubocop, EsLint, Prettier, and Test (Minitest / RSpec).
3. Add Github action status badge to the readme. Ref: Github Action Status Badge

Update rails 7 rc version to rails 7 stable version

Create logo and other assets

Dockerize the application

• Add one click heroku deployment
• Dockerize the App
• Add deployment to Kubernetes
• Whatever https://www.chatwoot.com/ supports

Admin user should be able to edit the company details under setting option.

Here is the link to the visual designs. https://www.figma.com/file/4gdPDRPqGqQqPYsO3Qj8CG/Miru-App?node-id=1154%3A16040

Ability to upload logo while adding company settings on first time sign up.

After new user signup, message should be displayed for email verification on login form.

Currently, after these sign up, they are redirected to the sign in form. The user is not informed that they need to click on the link in the email sent to login.

Expected : After the user signs up on Miru, on the sign up form a message should be displayed "An email has been sent to the registered email address. Please verify the link in the email to log in to Miru"

Spec out issues based on stakeholders

Ref: https://www.notion.so/saeloun/Miru-Web-3a38ca9cd60c42fc9e5de36c2d605d3a

Add sign up with Google option

Note:

• User should be able to sign up with google. ( User role should be the owner )
• Collect First name, last name, profile picture from google
• Skip Email confirmation for users those who sign up with google.

Implement the database schema structure

https://drawsql.app/null-53/diagrams/miru#

• Create the table and models based on the schema
• Add unit test and validations

Add daily time tracking/calendar view

• The employee/admin can able to add a new timesheet entry
• The employee/admin can able to view the submitted timesheet entries.
• The employee/admin can able to view the timesheet based on day

Add Code formatting and Linting

• Add Rubocop
• Add EsLint
• Add Prettier
• Add Husky Pre-Commit hook

Customise the error message displayed on forgot password page.

Currently standard messages are being displayed during the forgot password pages.

1. If the passwords don't match
2. In case if we enter the email address which is not registered.
3. If the password do not meet the criteria i.e. should be 6 characters minimum

Build the root page

Parent Issue: #41
--- Expected Behaviour ---

When I login in :
As an employee,

• I should be able to see the Navbar with the appropriate menu options. The time tracking should be the default option.
• I should log out of the app

As an admin,

• I should be able to see the Navbar with the appropriate menu options. Dashboard page should be default.
• I should log out of the app

Develop the functionality for admin to be able to remove an employee from the application.

https://saeloun.notion.site/Remove-Employee-8b44eecf96124c9eb19ed17f3ec60fc2

Setup a new Rails app with React

1. Create Rails 7 app

Build user profile page

• Route /profile
• User should be able to view the details
• User should be able to update the details

Develop the forgot password page

https://saeloun.notion.site/Forgot-Password-Page-2405b3c961c748d38a6674e8413f70c2

Fix the issues on Signup/login page

First name - Add validation that only alphabets can be entered. No numbers and special characters are allowed. Also the fields cannot be blank. So we need to show the * sign against the field.
Change the error message, position and format displayed when
1. Valid email address is not entered
2. Password are too short
3. Passwords do not match.
Change the content of email received to verify the email address after signing up.

Add backend functionality for set password

Develop the Project list Page

1. Develop the projects list page for Admin/Owner/Employee role.
2. User(Admin/owner/employee) should be able to view the clients name and project name.
3. The user (Admin/owner/employee) should be able to view the total hours logged against each project.
4. the user(Admin/owner/employee) should be able to search using Client name, project name.

Figma Design: https://www.figma.com/file/4gdPDRPqGqQqPYsO3Qj8CG/Miru-App?node-id=644%3A1873

Develop the set password page

Upgrade Ruby to ruby 3.1.0 and Rails to 7.0.1

Ref: https://www.ruby-lang.org/en/news/2021/12/25/ruby-3-1-0-released/

Develop functionality for admin to be able to add new employees

https://saeloun.notion.site/Add-Employees-d7bf91912f89447196dce8423231ea3a

Design data flow and structure

1. Create a data flow diagram
2. Create an ER diagram

Changes to Organisation setup page.

1. Company Name - Cannot be blank.
2. Logo - Edit icon should be displayed to remove the logo and upload new one.
3. Default country selected is Andorra - Lets make it as "Please select"
4. Default timezone selected is Andorra - Lets make it as "Please select"
5. Base Currency should be mandatory field. Please add a asterik sign against the field label- Lets make it as "Please select"
6. Fiscal year - Only two options should be displayed i.e. January -December & April - March
7. Business phone should not be an optional field.

Client Page

• Admin and Owner should be able to view the complete client page
• Users should be able to see the list of clients
• All users should be able to search a client