Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joaocarmo/somewhere-i-belong

Somewhere I Belong (SIB) is a user / group management system dashboard
https://github.com/joaocarmo/somewhere-i-belong

dashboard group-management user-management

Last synced: about 2 months ago
JSON representation

Somewhere I Belong (SIB) is a user / group management system dashboard

Awesome Lists containing this project

README

        

# Somewhere I Belong
[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)

Somewhere I Belong (SIB) is a simple user / group management system dashboard

## Technology

This mockup application makes use of the
[react-smart-data-table](https://github.com/joaocarmo/react-smart-data-table)
package.

## Requirements

This app uses an internal router which requires the server to be configured to
serve 404's with the root file `index.html`.

## Configuration

Several top level configurations can be tweaked in a dedicated file.

```txt
./lib/config.js
```

The navigation settings are also isolated from the rest of the application.

```txt
./lib/navigation.js
```

The API endpoints to the backend server are setup in a custom file as well.

```txt
./lib/api/api.js
```

In the absence of a backend server, the application relies on the browser's
`localStorage` engine. A faker to generate data on the fly is also included,
but disabled by default.

## Contribute

Always start by installing the project's dependencies.

```sh
yarn install
```

Start the development server with a simple command. The server will serve over
`http://localhost:3000/`.

```sh
yarn start
```

Run the tests.

```sh
yarn test
```

Build for production.

```sh
yarn build
```

Clean the builds from the directory.

```sh
yarn clean
```