eduulisboa / todo

To do app using Django Rest Framework, Vue.js and PostgreSQL.

To Do List App

Um aplicativo web de lista de tarefas, criado utilizando Django Rest Framework e Vue.js
https://todovuejs-lucasfranca.herokuapp.com/

💻 Tecnologias   |    🕵️ Sobre o projeto   |    🚀 Iniciando   |    🆙 Como contribuir   |    📬 Contate-me

💻 Tecnologias

• Django
• Django Rest Framework
• Vue.js
• Vuetify

🕵️ Sobre o projeto

To do, é um projeto criado com Django Rest Framework e Vue.js na intenção de aprender mais sobre essas duas tecnologias fantásticas. A partir de mais estudos irei atualizando o projeto para aplicandar as melhores práticas e fazer o melhor uso possível dessas tecnologias,

🚀 Iniciando o projeto

Existem duas maneiras de executar o projeto, a maneira legal e a maneira chata.

Usando Docker (É legal, um comando, produtividade.. e se não sabe usar docker tá na hora de aprender):

Para iniciar com Docker, tenha instalado em sua máquina o Docker e o Docker Compose. Tudo certinho? Então execute na pasta raíz do projeto:

sudo docker-compose up

Backend e Frontend disponíveis nas seguintes URLs:

• Back-end: http://localhost:8000/api/task
• Front-end: http://localhost:8080/

Agora se você escolheu o método chato... siga os passos abaixo:

Para executar o projeto, é só seguir a lista de tarefas e executar os comandos de cada passo em um terminal:

$ git clone https://github.com/lucasfrancaid/todo.git

$ cd todo/backend
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt

$ python manage.py migrate
$ python manage.py runserver

Backend funcionando, agora abra um novo terminal para executar os comando para rodar o frontend, acesse a pasta todo/frontend e execute os comandos do próximo passo:

$ npm install
$ npm run serve

Após rodar os comandos, os apps Backend e Frontend estarão disponíveis nas seguintes URLs:

• Back-end: http://localhost:8000/api/task
• Front-end: http://localhost:8080/

Obs: Além de utilizar o back-end pelo browser, você também pode consumir a API pelo postman:

E por último..

🆙 Como contribuir

• Faça um fork desse repositório
• Crie uma branch com sua feature, para isso execute git checkout -b nome-feature
• Desenvolva sua implementação, adicione seus commits e execute git push origin nome-feature
• Abra um Pull Request explanando sua implementação

📬 Contato

Lucas França
https://lucasfrancaid.com.br/