IFSOLVE
👨💻 Em desenvolvimento 👩💻
Descrição do projeto • Tecnologias • Setup • Documentação • Autores • Licença
# Descrição do projeto O sistema web IFSolve tem como objetivo atuar como um banco de questões que visa contribuir no âmbito acadêmico, permitindo a professores a elaboração e aplicação de avaliações, e estudantes no processo de aprendizagem com a prática de simulados e exercícios de diferentes áreas do conhecimento. Este é um projeto desenvolvido durante o curso de TADS (Tecnologia em Análise e Desenvolvimento de Sistemas) do IFRN-CNAT. # Tecnologias ## Front-end As seguintes ferramentas foram usadas na construção do projeto front-end: - [React](https://pt-br.reactjs.org/) - [Node.js](https://nodejs.org/en/) - [Tailwind](https://tailwindcss.com/) - [Axios](https://axios-http.com/ptbr/docs/intro) - [React Router Dom V6](https://reactrouter.com/en/v6.3.0/getting-started/overview) > Veja o arquivo [package.json](./frontend/package.json) ## Back-end As seguintes ferramentas foram usadas na construção do projeto back-end: - [Django Rest Framework](https://www.django-rest-framework.org/) - [Swagger](https://swagger.io/) > Veja o arquivo [requirements.txt](./backend/requirements.txt) # Setup ## Pré-requisitos Para executar o projeto você vai precisar ter instalado em sua máquina as seguintes ferramentas: - [Git](https://git-scm.com) - [Node.js](https://nodejs.org/en/) - [Yarn](https://yarnpkg.com/) - [Docker](https://docs.docker.com/get-docker/) - Editor de código sugerido: [VSCode](https://code.visualstudio.com/) ### Clonando o repositório via HTTPS ```bash $ git clone https://github.com/tads-cnat/ifsolve.git ``` ### Clonando o repositório via SSH ```bash $ git clone git@github.com:tads-cnat/ifsolve.git ``` ### Executando o projeto back-end O projeto web e o banco de dados foram constrídos em containers Docker. É necessário estar com o Docker Desktop rodando na máquina. Dentro do diretório */backend* (onde o arquivo docker-compose.yml foi criado), rodar os comandos: docker-compose build docker-compose up Para rodar comandos dentro do container, enquanto o projeto estiver rodando, usar o comando `docker exec -it backend_web_1 sh` para abrir o terminal. O banco de dados local ficará disponível para acesso na porta *5433*, mas se caso a porta já estiver ocupada na sua máquina, pode mudar no arquivo *docker-compose.yml*, na linha 13, e rodar o comando `docker-compose up`. O projeto estará disponível na rota `http://127.0.0.1:8000/` ### Executando o projeto front-end ###### Acesse o diretório do front-end ```bash cd ./ifsolve/frontend ``` ###### Baixe as dependências ```bash yarn install ``` ###### Inicie a aplicação ```bash yarn start ``` # Documentação Verifique o diretório [`docs`](./docs/) para a documentação do sistema # Autores
Alcides Dantas |
Diogo Santos |
Erick Carlos |
Israel Kleber |
Lívia Rachel |
Raphael Matias |