chore: clean up
This commit is contained in:
parent
50145d4d1a
commit
3a047b5bbe
|
|
@ -2,3 +2,4 @@
|
|||
example-project
|
||||
docs
|
||||
src/public/js
|
||||
build
|
||||
|
|
|
|||
19
README.md
19
README.md
|
|
@ -48,7 +48,6 @@ CLI | Config file | Description | Example
|
|||
```d``` | ```projectDir``` | Relative path to project source code directory | ```-d src```
|
||||
```e``` | ```entryPoint``` | Relative path to project source entry point file (must be inside ```dir```) | ```-e src/app.js```
|
||||
```x``` | ```excludeDir``` | Relative path(or paths separated by ```,```) to directories for exclusion | ```-x src/doc,src/thirdparty```
|
||||
```i``` | ```ideCmd``` | command to open file in IDE from bash (default 'webstorm') | ```-i code```
|
||||
```p``` | ```clientPort``` | Port for Codecrumbs client (optional, default *2018*) | ```-p 2019```
|
||||
```n``` | ```projectNameAlias``` | Project name alias (optional, default same as ```-d``` value) | ```-n my-hello-world```
|
||||
```C``` | - | Path to codecrumbs.config.js (optional, by default will try to find the file in PWD) | ```-C config/codecrumbs.config.js```
|
||||
|
|
@ -108,12 +107,6 @@ Current version supports next programming languages:
|
|||
|
||||
Please file an issue to support other language you would like to have.
|
||||
|
||||
### Download & Upload (learn and share your knowledge)
|
||||
|
||||
You can take a snapshot of application state at any point of time and share it with others. Simply download the json file of codecrumbs store (*top-right corner, "setup -> download"*). This json file can be then uploaded to codecrumbs (*top-right corner, "setup -> upload"*) to represent exactly same picture, even without having that project locally!
|
||||
|
||||
<img src="/docs/upload-feature-2.gif" width="100%"/>
|
||||
|
||||
### Dependencies
|
||||
> Note: In current version only [JavaScript, TypeScript] offer this feature
|
||||
|
||||
|
|
@ -131,18 +124,6 @@ UI explained:
|
|||
|
||||
[js2flowchart](https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart) is used in the sidebar to draw flowchart for the selected file code.
|
||||
|
||||
### IDE integration
|
||||
> Check ```-i``` CLI param first to configure command.
|
||||
|
||||
Navigate from browser to your code editor simply by clicking ```Command+click```(or ```Alt+click```) on a file or a codecrumb to open file in your IDE.
|
||||
|
||||
<img src="/docs/ide-integration.gif" width="100%"/>
|
||||
|
||||
## Case studies
|
||||
The tool (codecrumbs) allows us to learn, document and explain a codebase much faster. Also, with *Download & Upload* feature it becomes super easy to collect and share your "investigation results".
|
||||
|
||||
The ultimate goal is to have many case studies hosting at [https://codecrumbs.io](https://codecrumbs.io/). **The library of projects "explained with codecrumbs", the place for collaborative learning**. More features around that coming soon, stay tuned.
|
||||
|
||||
## Support
|
||||
Any support is very much appreciated! 👍 😘 ❤️
|
||||
If you like this project, please, **put a :star: and tweet about it**. Thanks!
|
||||
|
|
|
|||
|
|
@ -59,9 +59,6 @@ const App = (props = {}) => {
|
|||
<Suspense fallback={null}>
|
||||
<SideBar />
|
||||
</Suspense>
|
||||
{props.extraLayout.appBodyBottom && (
|
||||
<props.extraLayout.appBodyBottom.Component {...props} />
|
||||
)}
|
||||
</div>
|
||||
|
||||
<footer className="footer">
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
}
|
||||
|
||||
.settingContainer {
|
||||
display: flex;
|
||||
display: none;
|
||||
flex-direction: row;
|
||||
|
||||
.spacer {
|
||||
|
|
|
|||
|
|
@ -9,13 +9,13 @@ import dataBus from '../dataBus/reducer';
|
|||
import namespaceIntegration from '../namespaceIntegration/reducer';
|
||||
import rootSaga from './sagas';
|
||||
|
||||
export default ({ extraReducers = {}, extraPersistWhiteList = [] } = {}) => {
|
||||
export default () => {
|
||||
const sagaMiddleware = createSagaMiddleware();
|
||||
const composeEnhancers = window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose;
|
||||
|
||||
const persistConfig = {
|
||||
key: 'codecrumbs-config-storage',
|
||||
whitelist: ['controlsBus', ...extraPersistWhiteList],
|
||||
whitelist: ['controlsBus'],
|
||||
storage
|
||||
};
|
||||
|
||||
|
|
@ -24,8 +24,7 @@ export default ({ extraReducers = {}, extraPersistWhiteList = [] } = {}) => {
|
|||
combineReducers({
|
||||
controlsBus,
|
||||
dataBus,
|
||||
namespaceIntegration,
|
||||
...extraReducers
|
||||
namespaceIntegration
|
||||
})
|
||||
);
|
||||
|
||||
|
|
|
|||
|
|
@ -6,14 +6,13 @@ import { PersistGate } from 'redux-persist/integration/react';
|
|||
import App from './App';
|
||||
import getStore from './core/store';
|
||||
|
||||
const extraLayout = {};
|
||||
export default (options, mountNodeId) => {
|
||||
const { store, persistor } = getStore();
|
||||
|
||||
ReactDOM.render(
|
||||
<Provider store={store}>
|
||||
<PersistGate loading={null} persistor={persistor}>
|
||||
<App extraLayout={extraLayout} {...options} />
|
||||
<App {...options} />
|
||||
</PersistGate>
|
||||
</Provider>,
|
||||
document.getElementById(mountNodeId)
|
||||
|
|
|
|||
Loading…
Reference in New Issue