Skip to content

Latest commit

 

History

History
86 lines (70 loc) · 6.74 KB

README.md

File metadata and controls

86 lines (70 loc) · 6.74 KB
Raw

Portalo 📣 CircleCI GitHub branch checks state yarn License: GPL v2

Bring together your internal web applications!

Description

Portalo is an online web application that centralized your company's internal web applications and online tools into a single dashboard with a neat interface. From the dashboard, you can launch your applications/modules. Portalo's dashboard is hidden behind the login form powered by AWS Cognito. The user stays logged in until his logout. Unauthorized users get 403 and all mismatched routes result in 404. Furthermore, based on the logged user's privileges only corresponding applications (or part of the module) are shown to the user.

Currently, only the human resources module is implemented. It retrieves and updates data stored in AWS DynamoDB (through GRAPHQL and AWS Lambda functions). Data are searched via the user's username in a search form that autocompletes/suggests user name/username. GUI uses Ant Design.

Since the backend is hosted on AWS whole application follows pay-as-you-use model.

Live demo

This project is available on: portalo.bunat.cz using Vercel and AWS hosting & services.

Context

The project was created as part of the diploma thesis.

Author

Lukas Bunat

Usage

The application has a separate database (Cognito user pool) for login and the second one (DynamoDB) for info about users. Therefore, first register admin user that can create and edit other users' info. Admin should always create and fill users' info in the HR module and then let register user him/herself with the desired email. Cognito user pool and DynamoDB user bases are connected via username that is in email form.

Login/register

  1. On the register tab register user new
  2. Confirm user in popup modal with confirmation code that is sent to the registration email
  3. Login with registered username (email) and password

Human resources module

  1. Manage HR is shown only to admin users. This submodule allows to search users in DynamoDB with autocomplete feature. The user's info is then displayed and can be edited and saved. If a new username is added, the new user will be created in the DB.
  2. Submodules User info, Finances, Annual Leave only display retrieved information from DynamoDB about currently logged-in user.
  3. In all submodules user can ask by email to update his/her info.

Technology stack

  • JavaScript - JavaScript is the world's most popular and easy to learn programming language of the Web
  • TypeScript - Typed superset of JavaScript
  • create-react-app - Set up a modern web app by running one command.

Frontend

  • react.js - A JS lib for building user interfaces
    • react-router-dom - Declarative routing for React.js
    • React Hooks - React hooks such as: useState, useEffect, useReducer, useMemo, useContext
  • Yarn - Package manager
  • Sass - Preprocessor scripting language that is interpreted or compiled into Cascading Style Sheets (CSS)
  • Ant Design - React UI framework. A design system for enterprise-level products. Create an efficient and enjoyable work experienc
  • Apollo Client - Comprehensive state management library for JavaScript that enables you to manage both local and remote data with GraphQL

Backend

  • AWS Lambda - Serveless compute service as opposed to Node.js (server side JavaScript) with Express.js
  • AWS API Gateway - Create, maintain, and secure APIs at any scale
  • AWS Dynamo DB - Fast and flexible NoSQL key-value and document database that delivers single-digit millisecond performance at any scale
  • AWS IAM - Securely manage access to AWS services and resources
  • AWS Amplify - Fastest, easiest way to build mobile and web apps that scale
  • AWS Cognito - Simple and Secure User Sign-Up, Sign-In, and Access Control
  • GraphQL - A query language for your API
  • apollo-server-lambda - Apollo Server for AWS Lambda
  • serverless framework - Easy YAML + CLI development and deployment to AWS, Azure, Google Cloud, Knative & more

Testing

  • Cypress - Cypress is a next generation front end testing tool built for the modern web
    • Mocha.js - Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun
    • Chai.js - Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.
  • React Testing Library - React Testing Library builds on top of DOM Testing Library by adding APIs for working with React components.
    • Jest.js - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

Continuous integration

  • CircleCI - Our CI/CD platform lets teams build and deliver great software, quickly and at scale, in the cloud, or on your own infrastructure.

Installation

Frontend

  • To start development server: yarn start
  • Install modules: yarn install
  • Create a Build: yarn run build
  • Install aws amplify
    1. Install amplify cli with yarn install -g @aws-amplify/cli
    2. The first time do amplify configure
    3. Finally, amplify init to set up amplify

Backend

  1. Install serverless framework npm install -g serverless
  2. Navigate to /aws-server/ and run serverless deploy

Tests

  • To run headless e2e (Cypress) tests: yarn cypress run
  • To run GUI e2e (Cypress) tests: yarn run cypress open
  • To run integration routing (react-testing-library) tests: yarn run test

Licence

GNU GENERAL PUBLIC LICENSE