{"id":13554795,"url":"https://github.com/nunux-keeper/keeper-web-app","last_synced_at":"2025-04-03T07:32:50.399Z","repository":{"id":135689646,"uuid":"81866527","full_name":"nunux-keeper/keeper-web-app","owner":"nunux-keeper","description":"Nunux Keeper web app","archived":false,"fork":false,"pushed_at":"2022-03-29T19:05:34.000Z","size":2156,"stargazers_count":105,"open_issues_count":11,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-01T12:33:12.012Z","etag":null,"topics":["content-curation","reactjs","webapp"],"latest_commit_sha":null,"homepage":"https://app.nunux.org/keeper/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nunux-keeper.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-13T20:09:20.000Z","updated_at":"2024-05-22T02:50:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"2dc1018c-f55a-4ac7-b9b0-0775348e6193","html_url":"https://github.com/nunux-keeper/keeper-web-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunux-keeper%2Fkeeper-web-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunux-keeper%2Fkeeper-web-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunux-keeper%2Fkeeper-web-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunux-keeper%2Fkeeper-web-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nunux-keeper","download_url":"https://codeload.github.com/nunux-keeper/keeper-web-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222935625,"owners_count":17060398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["content-curation","reactjs","webapp"],"created_at":"2024-08-01T12:02:55.029Z","updated_at":"2024-11-04T03:31:18.105Z","avatar_url":"https://github.com/nunux-keeper.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","webapp"],"sub_categories":[],"readme":"# NUNUX Keeper Web App\n\n\u003e Your personal content curation service.\n\nNunux Keeper allow you to collect, organize, and display web documents.\n\n**This project is the official web frontend.**\n\n![Screenshot](screenshot.png)\n\n## Table of Contents\n1. [Requirements](#requirements)\n1. [Features](#features)\n1. [Installation](#installation)\n1. [Development server](#development-server)\n1. [Other commands](#other-commands)\n1. [Under the hood](#under-the-hood)\n1. [Structure](#structure)\n\n## Requirements\n\nDocker OR Node `^5.0.0`\n\n## Features\n\n* Welcome page\n* Login with external identity provider (Google, Twitter, etc.)\n* Manage labels to organize documents\n* Create document from scratch or from a remote location\n* Create document from another website thanks to the bookmarklet\n* Search documents with a powerful search engine\n* Share documents\n\n## Configuration\n\nBasic project configuration can be found in `etc/dev.env`. Here you'll be able\nto redefine some parameters:\n\n* REACT_APP_API_ROOT: Nunux Keeper API endpoint\n* REACT_APP_DEBUG: Activate debug mode\n\n## Installation\n\n\u003e Note that this project is \"only\" the web front end of the backend API of Linux\n\u003e Keeper. If you want to use your own API server you have to install first this\n\u003e project: [keeper-core-api](https://github.com/nunux-keeper/keeper-core-api)\n\nOnce configured for your needs (see section above), you can build the static\nWeb App into the directory of your choice:\n\n```bash\n$ git clone https://github.com/nunux-keeper/keeper-web-app.git\n$ cd keeper-web-app\n$ make install DEPLOY_DIR=/var/www/html\n```\n\nThen, you can serve this directory with your favorite HTTP server.\n\n## Development server\n\nWith Node:\n\n```shell\n$ git clone https://github.com/nunux-keeper/keeper-web-app.git\n$ cd keeper-web-app\n$ npm install       # Install Node modules listed in ./package.json (may take a\n                    # while the first time)\n$ npm start         # Compile and launch\n```\n\nOr with Docker:\n\n```shell\n$ git clone https://github.com/nunux-keeper/keeper-web-app.git\n$ cd keeper-web-app\n$ make build start  # Build Docker image and start it\n```\n\n## Other commands\n\nHere's a brief summary of available Docker commands:\n\n* `make help` - Show available commands.\n* `make build` - Build Docker image.\n* `make test` - Start container with tests.\n* `make start` - Start container in foreground.\n* `make deploy` - Start container in background.\n* `make undeploy` - Stop container in background.\n* `make logs` - View container logs.\n* `make install` - Install generated site into the deployment directory.\n\nHere's a brief summary of available NPM commands:\n\n* `npm start` - Start development server.\n* `npm run build` - Compiles the application to disk (`~/build`).\n* `npm run test` - Runs unit tests.\n* `npm run build-css`- Runs SASS to generate CSS file.\n\n## Under the hood\n\n* [React](https://github.com/facebook/react)\n* [Redux](http://redux.js.org/)\n* [React Router](https://github.com/ReactTraining/react-router)\n* [React Create App](https://github.com/facebookincubator/create-react-app)\n* [Sass](http://sass-lang.com/)\n* [ESLint](http://eslint.org)\n\n\n## Structure\n\nHere the folder structure:\n\n```\n.\n├── build               # Builded website\n├── etc                 # Configuration\n├── makefiles           # Makefiles\n├── public              # Static files to serve as is\n├── src                 # Application source code\n│   ├── api             # Backend API connector (real and mock)\n│   ├── components      # App components\n│   ├── layouts         # Components that dictate major page structure\n│   ├── middlewares     # Components that provide context and AuthN\n│   ├── store           # Redux store\n│   │   └── modules     # Redux modules\n│   ├── styles          # Application-wide styles\n│   ├── views           # Components that live at a route\n│   ├── App.js          # Application bootstrap and rendering\n│   ├── Routes.js       # Application routes\n│   └── index.js        # Application entry point\n└── test                # Unit tests\n```\n\n----------------------------------------------------------------------\n\nNUNUX Keeper\n\nCopyright (c) 2017 Nicolas CARLIER (https://github.com/ncarlier)\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\n----------------------------------------------------------------------\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnunux-keeper%2Fkeeper-web-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnunux-keeper%2Fkeeper-web-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnunux-keeper%2Fkeeper-web-app/lists"}