Skip to content

Latest commit

 

History

History
164 lines (118 loc) · 3.73 KB

README.md

File metadata and controls

164 lines (118 loc) · 3.73 KB
Raw

Omics

What is Omics?

Omics emerges as a solution for independent authors who do not have a clear way of distributing their own comics. Moreover, it is important for them to get a retribution for their works. This platform aims to create an interactive space to bring authors closer to potential readers. Anyone can upload and publish their work after going through a selection process. The platform distributes high-quality content, supporting new authors and those who already have experience in the field. It is important to emphasize the closeness between authors and readers.

An author is rewarded with monthly payments according to the impact of their work and the interaction achieved with the readers. On the other hand, the readers can subscribe to a plan to get access to premium content whose author has contracts with the platform. Omics has a rating system to promote its catalog. Any reader can rate, review and follow his favorite comics. By this way keeping them at hand is easier.

Nobody has to invest in paper, protecting the environment, and each reader receives personalized readings according to their preferences.

The process is simple: a user uploads and publishes a comic, and a content-manager approves his work. After generating enough engagement from the readings, the author can apply for a contract to earn money. At the same time, a reader can get access to free content and pay a monthly subscription to read the publications that have a contract. The income is distributed among all the authors.

Tools

  • NodeJS
  • Angular CLI
  • Docker and docker-compose
  • Make (commands)

Configuration

  • Para windows:
    • Descargar el installador Docker de escritorio (versión estable) de: https://www.docker.com/get-started
    • Habilitar hyperV (verificar que este habilitado container y hyperV en Caractrerística de Windows)
    • Verificar que no se inicie siempre con Windows al iniciar (reiniciar la computadora una vez instalado)
    • Para verificar que funciona
      • Ir al administrador Hyper-V
      • Ver que DockerDesktop este ejecutandose (sino doble click y ejecutarlo)
      • En caso de tener el problema de que "Hyper-V no se esta ejectuando"
        • Abrir un CMD (o Powershell) con Permisos de Administrador
        • Para comprobar que Hyper-V este funcionando ejecutar: bcdedit (ver si hypervisorlaunchtype este en auto)
        • Para cambiarlo ejecutar lo siguiente: bcdedit /set hypervisorlaunchtype auto
        • Reiniciar la máquina

Docker

Build backend and frontend:

docker-compose build

Run backend and frontend:

docker-compose up
  • Build and run frontend image: docker-compose up web
  • Build and run backend image: docker-compose up server (test in localhost:3000/api)

Recreate backend:

# Delete server container
docker-compose down

# Recreate server image and run this image as container
docker-compose up server

Only rebuild server and web images:

docker-compose build

Rust

Install rustup: rustup.rs. Support for GNU/Linux and Windows (64bit and 32bit: rustup-init.exe).

Run backend:

cargo run

Test backend:

cargo test

Build backend (for production):

cargo build --release

Populate

cd scripts
npm install
npm run populate

Angular

See web/README.md.

Install dependencies:

npm install

Run:

npm start

Make

Some commands have been added to a Makefile to use them easier.

Backend:

# Run server on PORT=3000
make run

# Build server for production
make build

# Build docker image
make docker

# Deploy
make heroku

Frontend:

# Install dependencies
make web-dependencies

# Run frontend
make web-run

# Build frontend for production
make web-build

# Deploy frontend
make web-deploy