Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refatoração do README e adição da logo #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 140 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,140 @@
*Psst — looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)*

---

# svelte app

This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template.

To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):

```bash
npx degit sveltejs/template svelte-app
cd svelte-app
```

*Note that you will need to have [Node.js](https://nodejs.org) installed.*


## Get started

Install the dependencies...

```bash
cd svelte-app
npm install
```

...then start [Rollup](https://rollupjs.org):

```bash
npm run dev
```

Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.


## Deploying to the web

### With [now](https://zeit.co/now)

Install `now` if you haven't already:

```bash
npm install -g now
```

Then, from within your project folder:

```bash
cd public
now
```

As an alternative, use the [Now desktop client](https://zeit.co/download) and simply drag the unzipped project folder to the taskbar icon.

### With [surge](https://surge.sh/)

Install `surge` if you haven't already:

```bash
npm install -g surge
```

Then, from within your project folder:

```bash
npm run build
surge public
```
<p style="text-align:right;">
<span class="emoji">🇺🇸</span>
<span class="emoji">🇧🇷</span>
</p>

![CollabCode](collabcode.png "Logo da CollabCode")

<p style="text-align:center;">

<img src="https://img.shields.io/badge/Build-In Progress-informational"/>

<a href="https://www.contributor-covenant.org/version/1/4/code-of-conduct.html">
<img src="https://img.shields.io/badge/Contributor Covenant-v1.4 adopted-ff69b4.svg"/>
</a>
<a href="https://github.com/CollabCodeTech/qattus-api/blob/master/LICENSE">
<img src="https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg" alt="License"></a>
<a href="https://discordapp.com/invite/YeeEAYj">
<img src="https://img.shields.io/badge/Chat-On Discord-7289da.svg"/></a>
</p>

# Qattus

Qattus é uma plataforma opensource de cursos online sobre tecnologia e programação.

## Para que serve?

Em construção.

## Por onde começar?

### Pré-requisitos

- Instalar a versão [Node](https://nodejs.org/en/) 10.16.2
- Instalar a versão [Npm](https://www.npmjs.com/) 6.9.0
- Instalar as extensões [Prettier](https://prettier.io/) e [Eslint](https://eslint.org/) no editor de código de sua preferência.

### Executando a aplicação

1. Faça um fork do projeto.

2. Faça um clone do repósiorio no seu computador:

Clone com HTTPS:

```
https://github.com/CollabCodeTech/qattus.git
```

Clone com SSH:

```
[email protected]:CollabCodeTech/qattus.git
```

3. Acesse a pasta do projeto:

```
cd qattus
```

4. Execute o comando a seguir para instalar todas as dependências do projeto:

```
npm install
```

5. Agora basta executar o comando a seguir para subir Qattus localmente:

```
npm run dev
```

6. Abre o navegador na porta [http://localhost:5000](http://localhost:5000).

## Como executar os testes?

Em construção

## Como contribuir?

### Ao contribuir para este projeto você aceita e concorda com as [regras de contribuição]().

1. Faça um _**Fork**_ do projeto.

2. Crie sua _**branch**_ contendo as alterações:

```
git checkout -b my-new-feature
```

3. Adicione suas alterações:

```
git add <nome-do-arquivo>
```

4. Confirme suas alterações:

```
git commit -m 'Adicione algum recurso'
```

5. Faça _**push**_ para a _**branch**_:
```
git push origin my-new-feature
```

Depois que a solicitação do seu _**Pull Request**_ for mesclada, você poderá excluir com segurança sua _**branch**_.

### Como criar um Pull Request no GitHub?

Em construção

## Status do build

Em construção.

## Como tirar dúvidas sobre o projeto?

Para dúvidas referentes ao código desenvolvido ou para configurar o ambiente em seu computador, por favor, abra uma [Issue](https://github.com/CollabCodeTech/qattus/issues) no GitHub que resonderemos o mais breve possível!

## [Código de Conduta](https://www.contributor-covenant.org/pt-br/version/1/4/code-of-conduct)

Qattus possui um código de conduta e espera-se que as pessoas participantes do projeto sigam. Por favor, leia o texto completo para que você entenda quais ações serão ou não toleradas.

# Idealizadores

- [Joviane Jardim](https://github.com/joviane)
- [Marco Bruno](https://github.com/MarcoBrunoBR)

## Contribuidores

Lista de [colaboradores](https://github.com/CollabCodeTech/qattus/graphs/contributors) que participaram deste projeto.

## Licença

[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)

(Documentação em desenvolvimento)

Binary file added collabcode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.