Giter Club home page Giter Club logo

openintra's Introduction

OpenIntra 🚀🏗

The OpenIntra is an Open Source Intranet System tailored for enterprises.

This frontend is powered by React⚡ and it was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

openintra's People

Contributors

samadhiwathsala avatar yasirunet avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

openintra's Issues

Authentication endpoints

If we can finalize the authentication endpoints from backend we can push it.

For example:
POST api/login
or
POST api/user/login

Any thoughts?

Roadmap for the project

The project consists of the following modules. We hope to go through the following module by module as listed below.

  • Employee contact registry.
  • Company Events/Meetings/working Calendar
  • Meeting room Booking system & meeting minutes
  • Management Availability schedule
  • Document Management system with permissions
  • Visitor Pass Approval system

Determine a state management strategy for frontend react app

There are lot of ways out there for managing state in React. But we think most of those are overwhelming and lot of things to do. The most popular one in the industry right now is Redux. There lot of competitors also available such as MobX.

According to my opinion, with the introduction of React hooks the state management of react is become lot easier and it solved lot of hassles in state management.

Global State

Passing prop from the parent component to the child until the data get the component that needs the data can be messy with the growth of the application. (Aka prop-drilling) Also, the mutate the state can be even harder.
To avoid this error most of the state management libraries such as Redux, MobX use global state to avoid issue mentioned above.

what we actually need?

Most of the time in SPA we need to fetch data from our backend and cache those to further use. As well as share the state between components. According to my opinion to do these things, the Redux or similar solutions are overwhelming.
Instead, I'm suggesting the following solution(s) for state management here.

  • Use the library called React Query to fetch data from our backend. (As well as caching, re-fetching)
  • User React hooks and Context API for share state between components.

What actually React Query offers?

According to their documentation, the following are the features they offer.

Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
Parallel + Dependent Queries
Mutations + Reactive Query Refetching
Multi-layer Cache + Automatic Garbage Collection
Paginated + Cursor-based Queries
Load-More + Infinite Scroll Queries w/ Scroll Recovery
Request Cancellation
React Suspense + Fetch-As-You-Render Query Prefetching
Dedicated Devtools (React Query Devtools)

Employee listing view

Need to create employee listing view. This view would be a usual data table that display information about the employees. This data table should have following features.

  • Register new employees
  • Sort particular employ from his phone number,department, Job title and view complete information about him/her.
  • Edit information about a employee.
  • Remove employee from the list.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.