@bigbinary/neeto-team-members-frontend 2.9.1 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -128
- package/dist/index.cjs.js +118 -508
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.js +91 -481
- package/dist/index.js.map +1 -1
- package/package.json +78 -38
- package/types.d.ts +4 -4
- /package/{src → app/javascript/src}/translations/en.json +0 -0
package/README.md
CHANGED
|
@@ -1,135 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# neeto-team-members-nano
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
This repo acts as the source of truth for the new nano's structure, configs,
|
|
4
|
+
data etc.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Local Development Setup
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
1. Setup
|
|
9
|
+
[Instructions](https://github.com/bigbinary/neeto-engineering/tree/main/Local-Development-Setup).
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
functioning of the package. Install all the peer dependencies using the below
|
|
12
|
-
command:
|
|
11
|
+
2. Run `yarn build` to bundle the app.
|
|
13
12
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
```
|
|
13
|
+
3. Visit http://spinkart.lvh.me:9100 and login with email `oliver@example.com`
|
|
14
|
+
and password `welcome`.
|
|
17
15
|
|
|
18
|
-
|
|
16
|
+
# Publish instructions
|
|
19
17
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## Usage
|
|
25
|
-
|
|
26
|
-
```jsx
|
|
27
|
-
import React from "react";
|
|
28
|
-
|
|
29
|
-
import { Roles, TeamMembers } from "@bigbinary/neeto-team-members-frontend";
|
|
30
|
-
import { BrowserRouter, Redirect, Route, Switch } from "react-router-dom";
|
|
31
|
-
import { ToastContainer } from "react-toastify";
|
|
32
|
-
|
|
33
|
-
import SideBar from "./components/Common/SideBar";
|
|
34
|
-
|
|
35
|
-
const App = () => (
|
|
36
|
-
<BrowserRouter>
|
|
37
|
-
<div className="flex">
|
|
38
|
-
<SideBar />
|
|
39
|
-
<Switch>
|
|
40
|
-
<Route exact path="/members">
|
|
41
|
-
<TeamMembers config={MEMBERS_CONFIG} />
|
|
42
|
-
</Route>
|
|
43
|
-
<Route exact path="/roles">
|
|
44
|
-
<Roles config={ROLES_CONFIG} />
|
|
45
|
-
</Route>
|
|
46
|
-
</Switch>
|
|
47
|
-
</div>
|
|
48
|
-
<ToastContainer />
|
|
49
|
-
</BrowserRouter>
|
|
50
|
-
);
|
|
51
|
-
|
|
52
|
-
export default App;
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
By default `TeamMembers` and `Roles` component will render without the config prop.
|
|
56
|
-
|
|
57
|
-
## Configurations
|
|
58
|
-
|
|
59
|
-
The configurations for the components present in this NPM package are given below. Click on them to read more:
|
|
60
|
-
|
|
61
|
-
1. [Roles](./docs/roles/README.md)
|
|
62
|
-
2. [TeamMembers](./docs/team_members/README.md)
|
|
63
|
-
3. [ManageMembers](./docs/manage_members/README.md)
|
|
64
|
-
4. [Permissions](./docs/permissions/README.md)
|
|
65
|
-
|
|
66
|
-
## Development
|
|
67
|
-
|
|
68
|
-
1. Install all the dependencies by executing the following command
|
|
69
|
-
|
|
70
|
-
```sh
|
|
71
|
-
yarn install
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
2. See the changes in the example app by executing the following command (from existing seed data):
|
|
75
|
-
|
|
76
|
-
```zsh
|
|
77
|
-
yarn dev
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
or to see the changes by running the Rails Engine in parallel, execute the following command:
|
|
81
|
-
|
|
82
|
-
```sh
|
|
83
|
-
yarn start
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
# Building and releasing.
|
|
87
|
-
|
|
88
|
-
The `@bigbinary/neeto-team-members-frontend` package gets published to NPM when we
|
|
89
|
-
merge a PR with `patch`, `minor` or `major` label to the `main` branch. The
|
|
90
|
-
`patch` label is used for bug fixes, `minor` label is used for new features and
|
|
91
|
-
`major` label is used for breaking changes. You can checkout the
|
|
92
|
-
`Create and publish releases` workflow in GitHub Actions to get a live update.
|
|
93
|
-
|
|
94
|
-
In case if you missed to add the label, you can manually publish the package.
|
|
95
|
-
For that first you need to create a PR to update the version number in the
|
|
96
|
-
`package.json` file and merge it to the `main` branch. After merging the PR, you
|
|
97
|
-
need to create a
|
|
98
|
-
[new github release](https://github.com/bigbinary/neeto-team-members-frontend/releases/new)
|
|
99
|
-
from main branch. Whenever a new release is created with a new version number,
|
|
100
|
-
the github actions will automatically publish the built package to npm. You can
|
|
101
|
-
checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
|
|
102
|
-
|
|
103
|
-
Please note that before publishing the package, you need to verify the
|
|
104
|
-
functionality in some of the neeto web-apps locally using `yalc` package
|
|
105
|
-
manager. The usage of yalc is explained in this video:
|
|
106
|
-
https://youtu.be/QBiYGP0Rhe0
|
|
107
|
-
|
|
108
|
-
## Integrations
|
|
109
|
-
|
|
110
|
-
| Projects | TeamMembers | Roles |
|
|
111
|
-
|----------------| :----------------: | :----------------: |
|
|
112
|
-
| neetoAuth | :white_check_mark: | :white_check_mark: |
|
|
113
|
-
| neetoCal | :white_check_mark: | :white_check_mark: |
|
|
114
|
-
| neetoChangelog | :white_check_mark: | :white_check_mark: |
|
|
115
|
-
| neetoChat | :white_check_mark: | :white_check_mark: |
|
|
116
|
-
| neetoCI | :white_check_mark: | :white_check_mark: |
|
|
117
|
-
| neetoCourse | :white_check_mark: | :white_check_mark: |
|
|
118
|
-
| neetoCRM | :white_check_mark: | :white_check_mark: |
|
|
119
|
-
| neetoDeploy | :white_check_mark: | :white_check_mark: |
|
|
120
|
-
| neetoDesk | :white_check_mark: | :white_check_mark: |
|
|
121
|
-
| neetoForm | :white_check_mark: | :white_check_mark: |
|
|
122
|
-
| neetoInvisible | :white_check_mark: | :white_check_mark: |
|
|
123
|
-
| neetoInvoice | :white_check_mark: | :white_check_mark: |
|
|
124
|
-
| neetoKB | :white_check_mark: | :white_check_mark: |
|
|
125
|
-
| neetoMonitor | :white_check_mark: | :white_check_mark: |
|
|
126
|
-
| neetoPlanner | :white_check_mark: | :white_check_mark: |
|
|
127
|
-
| neetoQuiz | :white_check_mark: | :white_check_mark: |
|
|
128
|
-
| neetoReplay | :white_check_mark: | :white_check_mark: |
|
|
129
|
-
| neetoRunner | :white_check_mark: | :white_check_mark: |
|
|
130
|
-
| neetoSign | :white_check_mark: | :white_check_mark: |
|
|
131
|
-
| neetoSite | :white_check_mark: | :white_check_mark: |
|
|
132
|
-
| neetoSocial | :white_check_mark: | :white_check_mark: |
|
|
133
|
-
| neetoTestify | :white_check_mark: | :white_check_mark: |
|
|
134
|
-
| neetoWheel | :white_check_mark: | :white_check_mark: |
|
|
135
|
-
| neetoWireframe | :white_check_mark: | :white_check_mark: |
|
|
18
|
+
1. [Engine and package installation](./docs/engine-and-package-installation.md)
|
|
19
|
+
2. [Building and releasing](./docs/building-and-releasing.md)
|