Uwazi is a web-based, open-source solution for building and sharing document collections
Latest commit 16ed9ea Nov 15, 2018
Permalink
Failed to load latest commit information.
.circleci changed circle ci cache version e2e Sep 14, 2018
.github Updated PR template since CI already runs e2e removed it from the che… Jun 25, 2018
app changed media Field to textarea Nov 15, 2018
blank_state/uwazi_development updated a translation in the blank state Mar 22, 2018
database yarn command to set the development admin user Oct 22, 2018
log PDF logs everything that happens on gs, docsplit and pdf2htmlex to lo… Aug 25, 2016
nightmare Fix e2e test Oct 29, 2018
public Replaced file no longer needed. Sep 21, 2018
server_configs/integration_server updated go configuratio Apr 22, 2016
uploaded_documents renamed uploads folder to uploaded_documents Feb 9, 2016
webpack moved ModuleConcatenationPlugin to production build only Apr 17, 2018
.babelrc Merge branch 'development' into update-font-awesome Jul 2, 2018
.codeclimate.yml updated exclude paterns for codeclimate Mar 27, 2018
.eslintrc refactor of FiltersForm and suopport for subFilters or "relationship Aug 2, 2018
.gitignore added webpack-bundle-analyzer Mar 20, 2018
LICENSE Create LICENSE Nov 22, 2017
README.md Update README.md Nov 9, 2018
message.js custom message when runing hot Mar 22, 2018
package.json Update package.json Nov 12, 2018
run.js throw an error instead of a a console.log on run.js Mar 23, 2018
server.js fixed css/scss extensions nodejs mock Sep 6, 2018
webpack.config.js final config for hot reload Feb 19, 2018
webpack.production.config.js Updated webpack and unglify plugin Jul 5, 2018
yarn.lock upgraded macaddress@0.2.9 Oct 16, 2018

README.md

Uwazi Logo

devDependency Status dependency Status CircleCI Maintainability Test Coverage

There are important stories within your documents. Uwazi helps you tell them. Uwazi is a free, open-source solution for organizing, analyzing and publishing your documents.

Uwazi | HURIDOCS

Read the user guide

Intallation guide

Dependencies

Before anything else you will need to install the application dependencies.

If you want to use the latest development code:

$ git clone https://github.com/huridocs/uwazi.git
$ cd uwazi
$ yarn install

If you just want to only use the latest stable release (recommended for production):

$ git clone -b master --single-branch https://github.com/huridocs/uwazi.git
$ cd uwazi
$ yarn install

Production

Production Build

$ yarn production-build

The first time you run Uwazi, you will need to initialize the database with its default blank values. Do no run this command for existing projects, as this will erase the entire database. Note that from this point you need ElasticSearch and MongoDB running.

$ yarn blank-state

Then start the server by typing:

$ yarn run-production

By default, Uwazi runs on localhost on the port 3000. So point your browser to http://localhost:3000 and authenticate yourself with the default username "admin" and password "change this password now".

Check out the user guide for more configuration options.

Upgrading Uwazi and data migrations

Updating Uwazi is pretty straight forward using git:

$ cd uwazi
$ git pull
$ yarn install
$ yarn migrate
$ yarn production-build
$ yarn run-production
  • If you are not using git, just download and overwrite the code in the Uwazi directory.
  • 'yarn install' will automatically add, remove or replace any changes in module dependecies.
  • 'yarn migrate' will track your last data version and, if needed, run a script over your data to modify it so that is up to date with your Uwazi version.

Development

Development Run

$ yarn hot

This will launch a webpack server and nodemon app server for hot reloading any changes you make.

Testing

Unit and Integration tests

We test using the JEST framework (built on top of Jasmine). To run the unit and integration tests, execute

$ yarn test

This will run the entire test suite, both on server and client apps.

End to End (e2e)

For End-to-End testing, we have a full set of fixtures that test the overall functionality. Be advised that, for the time being, these tests are run ON THE SAME DATABASE as the default database (uwazi_developmet), so running these tests will DELETE any exisisting data and replace it with the testing fixtures. DO NOT RUN ON PRODUCTION ENVIRONMENTS!

Running end to end tests require a running Uwazi app.

$ yarn hot

On a different console tab, run

$ yarn e2e

Note that if you already have an instance running, this will likely throw an error of ports already been used. Only one instance of Uwazi may be run in a the same port at the same time.

Default login

The application's default log in is admin / change this password now

Note the subtle nudge ;)