Skip to content

DemocraciaEnRed/colectiva-core

Header

Colectiva - Backend

Quality Gate Status GitHub license

Este es uno de los tres modulos que se requieren descargar, hacer setup e instalar cada uno de los repositorios para poder utilizar Colectiva. Para saber mas del conjunto de modulos que compone colectiva, hace click aqui


Setup colectiva-api

⚠️ NOTAS IMPORTANTES

El siguiente conjunto de sistemas requiere de:

  • Mongo3.6
  • Keycloak 4.4.x o 6.0.x

Sobre Mongo3.6, es necesario que instales mongo 3.6 en tu computadora, con una base de datos llamada "colectiva". No hace falta crear alguna collection, eso lo hace la app en inicio.

Keycloak es un sistema open source de identificación y gestión de acceso de usuarios. Es un sistema complejo y para fines de testing, en Democracia en Red sabemos que la instalacion de Keycloak puede ser un bloqueo para intenciones de testing. Para eso, comunicate con nosotros y podemos ayudarte a hacer el setup y utilizar nuestro Keycloak de Democracia en Red. Envianos un correo electronico en mailto:[email protected] o contactanos a través de nuestro Twitter.

Ir a la carpeta del repo y instalar las dependencias.

dev/:$ cd colectiva-api
dev/colectiva-api:$ npm install

Ahora tenemos que crear un archivo .env que son nuestras variables de entorno

PORT=4000
SESSION_SECRET=PleaseCreateASectretHERE
MONGO_URL=mongodb://localhost/colectiva
AUTH_SERVER_URL=##############TODO
AUTH_REALM=###################TODO
AUTH_CLIENT=##################TODO
NOTIFIER_URL=http://localhost:5000/api

Comando para ejecutar:

dev/colectiva-api:$ npm run dev

Full reference de enviroment vars

# App vars
PORT=3000
SESSION_SECRET=changeMe

# Database vars
MONGO_URL=mongodb://localhost/changeMe

# Keycloak 
AUTH_REALM=changeMe
AUTH_SERVER_URL=changeMe
AUTH_CLIENT=changeMe
# For test env only
#AUTH_ADMIN_TEST_USERNAME=changeMe
#AUTH_ADMIN_TEST_PASSWORD=changeMe

# Notifier
NOTIFIER_URL=http://place-notifier-url

# (Optional) Community defaults
#COMMUNITY_NAME=changeMe
#COMMUNITY_COLOR_HEX=3177cc

📓 Note for production build

  • Be sure to use "keycloak-connect": "^4.8.3" in package.json

Licencia

El siguiente repositorio es un desarrollo de codigo abierto bajo la licencia GNU General Public License v3.0. Pueden acceder a la haciendo click aqui.

About

Implementacion modulo backend de co-construcción de leyes

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages