Pular para o conteúdo principal

Exemplo README.md

Arquivo README.md é o arquivo que é exibido na página inicial do repositório no GitHub. Ele deve conter informações básicas sobre o projeto, como:

  • Nome
  • Breve descrição
  • Dependências
  • Como instalar/rodar

Exemplo de README.md​

<p align="center">
  <img
    width="250px"
    alt="ONZ Software"
    src="https://github.com/ONZ-Software/onz-docs/blob/master/static/img/logo.svg"
  />
  <h1 align="center">Projeto Exemplo</h1>
</p>

> Projeto de exemplo para o repositório do GitHub. Este projeto é um template para projetos da ONZ Software.

## Dependências

- Node.js
- Yarn
- Docker
- Docker Compose
- PostgreSQL
- Redis

## Instalação

Siga os passos abaixo para instalar o projeto.

### Instalar dependências

```bash
yarn install
```

### Criar arquivo .env

```bash
cp .env.example .env
```

### Criar banco de dados

```bash
docker-compose up -d
```

### Executar migrations e seeds

```bash
# migrations
yarn prisma migrate dev
# seeds
yarn prisma db seed
```

### Iniciar projeto

```bash
yarn dev
```