/2022.2-CopoCheio

Primary LanguageTypeScript

CopoCheio

CopoCheio is a simple collaborative platform for drinks recipes.

With CopoCheio you can explore new recipes and make a favourite list.

Getting started • Installation • Configuration • Integrations

Getting started

If you are looking to contribute to the project make sure to read the Contribution Guide and the Code of conduct before doing anything.

Looking for documents? It's in this website.

Didn't find what you were looking for? You can try:

  • Looking in open and closed issues.
  • Looking in open and closed pull requests
  • Openning a issue.

Installation

To use the plataform you'll need:

  • Git
  • Docker
  • Docker-Compose
  • Node (Only if you are lookin to run it without docker, or intend to install new packages)
  • Postgres, no link :( (Only if you are lookin to run it without docker)

Cloning the repository

$ git clone https://github.com/UnBArqDsw2022-2/2022.2-CopoCheio.git
$ cd 2022.2-CopoCheio

Running docs

To run docs you'll have to install Docsify After that just run

$ docsify serve docs

Running containers

This command run all containers

$ docker-compose up -D

To run some containers just add the name after the -D

$ docker-compose up -D api postgres

Stopping containers

$ docker-compose down

Deleting all data from containers

$ docker-compose down -v

Without docker

To run without docker you'll have to create a database, we used postgres.

You'll have to run npm install or similars to install the packages in the folders:

  • front-end
  • back-end
  • front-admin
$ cd front-end
$ npm install

Running front-* folders

$ npm run start

Running back-end folder

$ npm run dev

Configuration

With docker

You just need to edit the .env file in the root of repository with the .env.example in mind.

Without docker

You need to edit the .env file in the folders back-end, front-end, front-admin and all of the folders have an .env.example to guide.