0.2.1 • Published 6 years ago
udia v0.2.1
UDIA
You are one with the universe.
Quickstart
Clone Repo: git clone git@github.com:udia-software/udia.git && cd udia
Docker
Docker mode is the staging environment.- Start the application with
docker-compose up
Manual
Manual is reccommended for live reloading and development.- Ensure you have a sql database accessible and ready. (
postgressupported)- You can use docker!
docker-compose -f dev-compose.yml upand the defaults env variables all work. - To view raw database, connect to docker container with
psql -h 0.0.0.0 -p 5432 -U pguser -d udiadb
- You can use docker!
- Set your database connection values. (see Environment Variables)
- Install dependencies:
yarn install - Run database migrations
yarn runMigrations - Watch application:
yarn watchor run applicationyarn startor test applicationyarn test
Environment Variables
These environment variables can be set by modifying your ~/.*rc or ~/.*profile files. Alternatively, modify the environment variables in the docker-compose files.
| Environment Variable Name | Default Value | Description |
|---|---|---|
NODE_ENV | development | Node Environment |
PORT | 3000 | Express port |
TYPEORM_TYPE | postgres | Database (postgres officially supported) |
TYPEORM_LOGGING | true | Log SQL queries to console |
SQL_USER | pguser | SQL User |
SQL_PASSWORD | mysecretpassword | SQL Password |
SQL_HOST | localhost | SQL Hostname |
SQL_PORT | 5432 | SQL Port Number for serving |
SQL_DB | udiadb | SQL Database name (test: udiadbtest) |
SQL_TEST_PORT | 5433 | SQL Port number for testing |
SQL_TEST_DB | udiadbtest | SQL Database name for testing |
JWT_SECRET | DEVELOPMENT_SECRET | Secret string to use for JWT encryption |
CORS_ORIGIN | http://localhost:3001 | OPTIONS Res Header for Access-Control-Allow-Origin |
CLIENT_DOMAINNAME | localhost:3001 | Domain:port of client (udia.ca) |
CLIENT_PROTOCOL | http | Protocol of Client (https) |
EMAIL_TOKEN_TIMEOUT | 3600000 | How long should an email token last |
SMTP_USERNAME | xxlvhieo2gqp352o@ethereal.email | SMTP Username (ethereal default) |
SMTP_PASSWORD | rCJTErmv6v2uacmdRt | SMTP Password |
SMTP_HOST | smtp.ethereal.email | SMTP Host (ethereal default) |
SMTP_PORT | 587 | SMTP Port |
REDIS_URL | redis://localhost:6379 | Redis Connection String |
HEALTH_METRIC_INTERVAL | 500 | How often to send health metric |
DEV_JWT | "" | Test/Dev/graphiql` passHeader jwt |
License
This is free software, licensed under GNU Affero General Public License v3 (AGPL-3.0).
Copyright (C) 2018 Alexander Wong <alex@udia.ca>, Udia Software Incorporated
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.