Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrekuratomi/kanvas


https://github.com/andrekuratomi/kanvas

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

## kanvas

- [Sobre](#sobre)
- [Instalação](#instalação)
- [Documentação](#documentação)
- [Termos de uso](#termos-de-uso)


# Sobre

kanvas é uma API de gerenciamento de usuários e cursos semelhante à plataforma [Canvas](https://www.canvas.net/). Esta aplicação utiliza o framework Django e o banco de dados SQLite3.

# Instalação

0. Primeiramente, é necessário já ter instalado na própria máquina:

- Um editor de código, conhecido também como IDE. Por exemplo, o [Visual Studio Code (VSCode)](https://code.visualstudio.com/).

- Uma ferramenta cliente de API REST. Por exemplo, o [Insomnia](https://insomnia.rest/download) ou o [Postman](https://www.postman.com/product/rest-client/).

-

E versionar o diretório para receber o clone da aplicação:

```
git init
```



1. Fazer o clone do reposítório Kanvas na sua máquina pelo terminal do computador ou pelo do IDE:

```
git clone https://github.com/AndreKuratomi/kanvas.git
```

Entrar na pasta criada:

```
cd kanvas
```

Após feito o clone do repositório Kanvas, instalar:

O ambiente virtual e atualizar suas dependências com o seguinte comando:

```
python -m venv venv --upgrade-deps
```

Ative o seu ambiente virtual com o comando:

```
source/venv/bin/activate
```

Instalar suas dependências:

```
pip install -r requirements.txt
```

E rodar a aplicação:

```
code .
```

# Documentação

Para ter acesso às descrições, detalhes das rotas e seus retornos, conferir documentação completa no link a seguir:

https://kanvas-documentation.vercel.app/

# Termos de uso

Esse projeto atende a fins exclusivamente didáticos e sem nenhum intuito comercial.